de.geeksfactory.opacclient.objects

Class Library

java.lang.Object

de.geeksfactory.opacclient.objects.Library

All Implemented Interfaces:

java.lang.Comparable<Library>

public class Library
extends java.lang.Object
implements java.lang.Comparable<Library>

Object representing a supported library

Constructor Summary

Constructors

Constructor and Description
Library()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Library arg0)
boolean	equals(java.lang.Object obj) Evaluates, whether this object represents the same library as the given one.
static Library	fromJSON(java.lang.String ident, org.json.JSONObject input) Create a Library object based on a JSONObject.
java.lang.String	getApi() Get the name of the API implementation used for this library
java.lang.String	getCity() Get the city the library is located in
java.lang.String	getCountry()
org.json.JSONObject	getData() Get additional data from JSON configuration
java.lang.String	getDisplayName() The official name of the library to display e.g. in the account detail view.
float	getGeo_distance()
double[]	getGeo() Get latitude and longitude of the library's geolocation
java.lang.String	getIdent() Get the library's identifier (in OpacClient app this is the filename in assets/bibs/ without the .json extension)
java.lang.String	getInformation() Gets the URL of this library's information webpage
java.lang.String	getReplacedBy()
java.lang.String	getState()
java.lang.String	getTitle() Get an additional name of the library if it is not the main public library in the city it is located in
int	hashCode()
boolean	isAccountSupported() Get whether this library supports accounts.
boolean	isNfcSupported() Get if this library is known to have NFC tags inside their books which work with the app's NFC search feature.
void	setAccountSupported(boolean account_supported) Set whether this library supports accounts
void	setApi(java.lang.String api) Set the name of the API implementation used for this library
void	setCity(java.lang.String city) Set the city the library is located in
void	setCountry(java.lang.String country)
void	setData(org.json.JSONObject data) Set additional data from JSON configuration
void	setDisplayName(java.lang.String displayName) Set the official name of the library to display e.g. in the account detail view.
void	setGeo_distance(float geo_distance)
void	setGeo(double[] geo) Set latitude and longitude of the library's geolocation
void	setIdent(java.lang.String ident) Set the library's unique identifier.
void	setInformation(java.lang.String information) Sets the URL of this library's information webpage
void	setNfcSupported(boolean nfcSupported) Set if this library is known to have NFC tags inside their books which work with the app's NFC search feature.
void	setReplacedBy(java.lang.String replacedby)
void	setState(java.lang.String state)
void	setTitle(java.lang.String title) Set an additional name of the library if it is not the main public library in the city it is located in

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Library

public Library()

Method Detail

fromJSON

public static Library fromJSON(java.lang.String ident,
                               org.json.JSONObject input)
                        throws org.json.JSONException

Create a Library object based on a JSONObject.

Parameters:

ident - identifier

input - input data

Returns:

new Library object

Throws:

org.json.JSONException - if parsing failed or objects were missing

See Also:

getIdent()

getIdent

public java.lang.String getIdent()

Get the library's identifier (in OpacClient app this is the filename in assets/bibs/ without the .json extension)

Returns:

unique library identifier

setIdent

public void setIdent(java.lang.String ident)

Set the library's unique identifier.

Parameters:

ident - Identifier

getCity

public java.lang.String getCity()

Get the city the library is located in

Returns:

city name

setCity

public void setCity(java.lang.String city)

Set the city the library is located in

Parameters:

city - city name

getTitle

public java.lang.String getTitle()

Get an additional name of the library if it is not the main public library in the city it is located in

Returns:

a title, not including the city's name

setTitle

public void setTitle(java.lang.String title)

Set an additional name of the library if it is not the main public library in the city it is located in

Parameters:

title - a title, not including the city's name

getDisplayName

public java.lang.String getDisplayName()

The official name of the library to display e.g. in the account detail view. Returns "city · title" if not set.

Returns:

a name, including the city's name

setDisplayName

public void setDisplayName(java.lang.String displayName)

Set the official name of the library to display e.g. in the account detail view. Optional.

getApi

public java.lang.String getApi()

Get the name of the API implementation used for this library

Returns:

API implementation

setApi

public void setApi(java.lang.String api)

Set the name of the API implementation used for this library

Parameters:

api - API implementation (like "bond26")

getData

public org.json.JSONObject getData()

Get additional data from JSON configuration

Returns:

"data" object from JSON file

setData

public void setData(org.json.JSONObject data)

Set additional data from JSON configuration

Parameters:

data - "data" object from JSON file

getCountry

public java.lang.String getCountry()

Returns:

the country

setCountry

public void setCountry(java.lang.String country)

Parameters:

country - the country to set

getState

public java.lang.String getState()

Returns:

the state

setState

public void setState(java.lang.String state)

Parameters:

state - the state to set

getGeo

public double[] getGeo()

Get latitude and longitude of the library's geolocation

Returns:

Array of latitude and longitude

setGeo

public void setGeo(double[] geo)

Set latitude and longitude of the library's geolocation

Parameters:

geo - Array of latitude and longitude

getReplacedBy

public java.lang.String getReplacedBy()

setReplacedBy

public void setReplacedBy(java.lang.String replacedby)

isAccountSupported

public boolean isAccountSupported()

Get whether this library supports accounts.

Returns:

boolean describing whether this library supports accounts

setAccountSupported

public void setAccountSupported(boolean account_supported)

Set whether this library supports accounts

Parameters:

account_supported - describing whether this library supports accounts

getInformation

public java.lang.String getInformation()

Gets the URL of this library's information webpage

setInformation

public void setInformation(java.lang.String information)

Sets the URL of this library's information webpage

isNfcSupported

public boolean isNfcSupported()

Get if this library is known to have NFC tags inside their books which work with the app's NFC search feature. Defaults to false if not set.

setNfcSupported

public void setNfcSupported(boolean nfcSupported)

Set if this library is known to have NFC tags inside their books which work with the app's NFC search feature. Defaults to false if not set.

getGeo_distance

public float getGeo_distance()

Returns:

Geo distance - only for temporary use.

setGeo_distance

public void setGeo_distance(float geo_distance)

Parameters:

geo_distance - Set the geo distance - only for temporary use.

compareTo

public int compareTo(Library arg0)

Specified by:

compareTo in interface java.lang.Comparable<Library>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Evaluates, whether this object represents the same library as the given one. Only the library ident (aka. filename) is taken into consideration!

Overrides:

equals in class java.lang.Object