de.geeksfactory.opacclient.apis

Class Littera

java.lang.Object

de.geeksfactory.opacclient.apis.BaseApi

de.geeksfactory.opacclient.apis.SearchOnlyApi

de.geeksfactory.opacclient.apis.Littera

All Implemented Interfaces:

OpacApi

public class Littera
extends SearchOnlyApi

An implementation of *.web-opac.at sites operated by the Austrian company Littera.

Nested Class Summary

Nested classes/interfaces inherited from interface de.geeksfactory.opacclient.apis.OpacApi

OpacApi.CancelResult, OpacApi.MultiStepResult, OpacApi.OpacErrorException, OpacApi.ProlongAllResult, OpacApi.ProlongResult, OpacApi.ReservationResult

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Map<java.lang.String,java.lang.String>	LANGUAGE_CODES
protected java.lang.String	languageCode
protected java.util.List<SearchQuery>	lastQuery
protected static java.util.Map<java.lang.String,SearchResult.MediaType>	MEDIA_TYPES
protected java.lang.String	opac_url
protected static java.util.List<java.lang.String>	SEARCH_FIELDS_FOR_DROPDOWN

Fields inherited from class de.geeksfactory.opacclient.apis.BaseApi

http_client, httpLoggingEnabled, initialised, KEY_SEARCH_QUERY_AUDIENCE, KEY_SEARCH_QUERY_AUTHOR, KEY_SEARCH_QUERY_AVAILABLE, KEY_SEARCH_QUERY_BARCODE, KEY_SEARCH_QUERY_BRANCH, KEY_SEARCH_QUERY_CATEGORY, KEY_SEARCH_QUERY_DIGITAL, KEY_SEARCH_QUERY_FREE, KEY_SEARCH_QUERY_HOME_BRANCH, KEY_SEARCH_QUERY_ISBN, KEY_SEARCH_QUERY_KEYWORDA, KEY_SEARCH_QUERY_KEYWORDB, KEY_SEARCH_QUERY_LOCATION, KEY_SEARCH_QUERY_ORDER, KEY_SEARCH_QUERY_PUBLISHER, KEY_SEARCH_QUERY_SYSTEM, KEY_SEARCH_QUERY_TITLE, KEY_SEARCH_QUERY_YEAR, KEY_SEARCH_QUERY_YEAR_RANGE_END, KEY_SEARCH_QUERY_YEAR_RANGE_START, library, stringProvider, supportedLanguages

Fields inherited from interface de.geeksfactory.opacclient.apis.OpacApi

SUPPORT_FLAG_ACCOUNT_PROLONG_ALL, SUPPORT_FLAG_CHANGE_ACCOUNT, SUPPORT_FLAG_ENDLESS_SCROLLING, SUPPORT_FLAG_QUICKLINKS, SUPPORT_FLAG_WARN_PROLONG_FEES, SUPPORT_FLAG_WARN_RESERVATION_FEES

Constructor Summary

Constructors

Constructor and Description
Littera()

Method Summary

Modifier and Type	Method and Description
protected void	addAdvancedSearchFields(java.util.List<SearchField> fields)
protected void	addDropdownValuesForField(DropdownSearchField field, java.lang.String id)
protected void	addSimpleSearchField(java.util.List<SearchField> fields)
protected void	addSortingSearchFields(java.util.List<SearchField> fields)
protected java.lang.String	buildSearchUrl(java.util.List<SearchQuery> query, int page)
protected SearchRequestResult	executeSearch(java.util.List<SearchQuery> query, int pageIndex)
SearchRequestResult	filterResults(Filter filter, Filter.Option option) If your OpacApi.search(List) implementation puts something different from null into SearchRequestResult.setFilters(List), this will be called to apply a filter to the last search request.
protected java.lang.String	getApiUrl()
protected java.lang.String	getDefaultEncoding()
protected java.lang.String	getLanguage()
DetailledItem	getResult(int position) Get details for the item at position from last OpacApi.search(java.util.List<de.geeksfactory.opacclient.searchfields.SearchQuery>) or OpacApi.searchGetPage(int) call.
DetailledItem	getResultById(java.lang.String id, java.lang.String homebranch) Get details for the item with unique ID id.
java.lang.String	getShareUrl(java.lang.String id, java.lang.String title) Some library systems allow us to share search results.
java.util.Set<java.lang.String>	getSupportedLanguages() Get all languages supported by this library.
int	getSupportFlags() Return which optional features your API implementation supports.
void	init(Library library, HttpClientFactory httpClientFactory) Initializes HTTP client and String Provider
java.util.List<SearchField>	parseSearchFields()
SearchRequestResult	search(java.util.List<SearchQuery> query) Performs a catalogue search.
SearchRequestResult	searchGetPage(int page) Get result page page of the search performed last with OpacApi.search(java.util.List<de.geeksfactory.opacclient.searchfields.SearchQuery>).
void	setLanguage(java.lang.String language) Set the language to use.

Methods inherited from class de.geeksfactory.opacclient.apis.SearchOnlyApi

account, cancel, checkAccountData, prolong, prolongAll, reservation

Methods inherited from class de.geeksfactory.opacclient.apis.BaseApi

buildHttpGetParams, cleanUrl, convertStreamToString, convertStreamToString, downloadCover, getQueryParams, getQueryParamsFirst, getSearchFields, httpGet, httpGet, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, logHttpError, searchQueryListToMap, setHttpLoggingEnabled, setStringProvider, shouldUseMeaningDetector, start, volumeSearch

Methods inherited from class java.lang.Object

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

Field Detail

LANGUAGE_CODES

protected static final java.util.Map<java.lang.String,java.lang.String> LANGUAGE_CODES

MEDIA_TYPES

protected static final java.util.Map<java.lang.String,SearchResult.MediaType> MEDIA_TYPES

SEARCH_FIELDS_FOR_DROPDOWN

protected static final java.util.List<java.lang.String> SEARCH_FIELDS_FOR_DROPDOWN

opac_url

protected java.lang.String opac_url

languageCode

protected java.lang.String languageCode

lastQuery

protected java.util.List<SearchQuery> lastQuery

Constructor Detail

Littera

public Littera()

Method Detail

init

public void init(Library library,
                 HttpClientFactory httpClientFactory)

Description copied from class: BaseApi

Initializes HTTP client and String Provider

Specified by:

init in interface OpacApi

Overrides:

init in class BaseApi

Parameters:

library - The library the Api is initialized for

httpClientFactory - A HttpClientFactory instance that will be used for instantiating HTTP clients. This factory is pluggable because we want to use platform-specific code on Android.

getApiUrl

protected java.lang.String getApiUrl()

search

public SearchRequestResult search(java.util.List<SearchQuery> query)
                           throws java.io.IOException,
                                  OpacApi.OpacErrorException,
                                  org.json.JSONException

Description copied from interface: OpacApi

Performs a catalogue search. The given List<SearchQuery> contains the search criteria. See documentation on SearchResult for details. This function is always called from a background thread, you can use blocking network operations in it. See documentation on DetailledItem for details.

Parameters:

query - see above

Returns:

List of results and additional information, or result object with the error flag set to true.

Throws:

org.json.JSONException

java.io.IOException

OpacApi.OpacErrorException

See Also:

SearchResult

searchGetPage

public SearchRequestResult searchGetPage(int page)
                                  throws java.io.IOException,
                                         OpacApi.OpacErrorException,
                                         org.json.JSONException

Description copied from interface: OpacApi

Get result page page of the search performed last with OpacApi.search(java.util.List<de.geeksfactory.opacclient.searchfields.SearchQuery>). This function is always called from a background thread, you can use blocking network operations in it. See documentation on DetailledItem for details.

Parameters:

page - page number to fetch

Returns:

List of results and additional information, or result object with the error flag set to true.

Throws:

java.io.IOException

OpacApi.OpacErrorException

org.json.JSONException

See Also:

OpacApi.search(List), SearchResult

executeSearch

protected SearchRequestResult executeSearch(java.util.List<SearchQuery> query,
                                            int pageIndex)
                                     throws java.io.IOException,
                                            OpacApi.OpacErrorException,
                                            org.json.JSONException

Throws:

java.io.IOException

OpacApi.OpacErrorException

org.json.JSONException

buildSearchUrl

protected java.lang.String buildSearchUrl(java.util.List<SearchQuery> query,
                                          int page)
                                   throws java.io.IOException,
                                          org.json.JSONException,
                                          java.net.URISyntaxException

Throws:

java.io.IOException

org.json.JSONException

java.net.URISyntaxException

getResultById

public DetailledItem getResultById(java.lang.String id,
                                   java.lang.String homebranch)
                            throws java.io.IOException,
                                   OpacApi.OpacErrorException

Description copied from interface: OpacApi

Get details for the item with unique ID id. This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

id - id of object to fetch

homebranch - The users "home branch". "Home" library branch. Some library systems require this information at search request time to determine where book reservations should be placed. If in doubt, set to null.

Returns:

Media details

Throws:

java.io.IOException

OpacApi.OpacErrorException

See Also:

DetailledItem

filterResults

public SearchRequestResult filterResults(Filter filter,
                                         Filter.Option option)
                                  throws java.io.IOException,
                                         OpacApi.OpacErrorException

Description copied from interface: OpacApi

If your OpacApi.search(List) implementation puts something different from null into SearchRequestResult.setFilters(List), this will be called to apply a filter to the last search request. If your OpacApi.search(List) implementation does not set SearchRequestResult.setFilters(List), this wil never be called. Just return null. This function is always called from a background thread, you can use blocking network operations in it. See documentation on DetailledItem for details.

Parameters:

filter - The filter to be applied.

option - The filters option to be applied. If the option.isApplied() returns true, the filter is to be removed!

Returns:

List of results and additional information, or result object with the error flag set to true.

Throws:

java.io.IOException

OpacApi.OpacErrorException

See Also:

SearchResult, Filter

getResult

public DetailledItem getResult(int position)
                        throws java.io.IOException,
                               OpacApi.OpacErrorException

Description copied from interface: OpacApi

Get details for the item at position from last OpacApi.search(java.util.List<de.geeksfactory.opacclient.searchfields.SearchQuery>) or OpacApi.searchGetPage(int) call. We generally prefer OpacApi.getResultById(String, String), so if you implement getResultById AND every search result of your driver has an id set, you can omit this method (respectively, return null). This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

position - position of object in last search

Returns:

Media details

Throws:

java.io.IOException

OpacApi.OpacErrorException

See Also:

DetailledItem

parseSearchFields

public java.util.List<SearchField> parseSearchFields()
                                              throws java.io.IOException,
                                                     OpacApi.OpacErrorException,
                                                     org.json.JSONException

Specified by:

parseSearchFields in class BaseApi

Throws:

java.io.IOException

OpacApi.OpacErrorException

org.json.JSONException

addSimpleSearchField

protected void addSimpleSearchField(java.util.List<SearchField> fields)
                             throws java.io.IOException,
                                    org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

addAdvancedSearchFields

protected void addAdvancedSearchFields(java.util.List<SearchField> fields)
                                throws java.io.IOException,
                                       org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

addDropdownValuesForField

protected void addDropdownValuesForField(DropdownSearchField field,
                                         java.lang.String id)
                                  throws java.io.IOException,
                                         org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

addSortingSearchFields

protected void addSortingSearchFields(java.util.List<SearchField> fields)
                               throws java.io.IOException,
                                      org.json.JSONException

Throws:

java.io.IOException

org.json.JSONException

getDefaultEncoding

protected java.lang.String getDefaultEncoding()

Overrides:

getDefaultEncoding in class BaseApi

getShareUrl

public java.lang.String getShareUrl(java.lang.String id,
                                    java.lang.String title)

Description copied from interface: OpacApi

Some library systems allow us to share search results. If your library system allows this natively (to link directly on search results), you can return the corresponding URL with this function. If your library does not support this at all, return null. If you library only accepts direkt links when a session is open, get in touch with me (mail@raphaelmichel.de) to get it integrated in the opacapp.de proxy.

Parameters:

id - Media id of the item to be shared

title - Title of the item to be shared

Returns:

An URL or null.

getSupportFlags

public int getSupportFlags()

Description copied from interface: OpacApi

Return which optional features your API implementation supports.

Returns:

combination (bitwise OR) of SUPPORT_FLAG_* constants

getSupportedLanguages

public java.util.Set<java.lang.String> getSupportedLanguages()
                                                      throws java.io.IOException

Description copied from interface: OpacApi

Get all languages supported by this library. This will be a Set of language codes defined in ISO-639-1 (two-letter codes in lower case, see this list). We don't need to use this function in the app because the API will automatically fall back if the language set is not supported, but it is used in the MeaningDetector tool to get search fields for all supported languages. This function may use blocking network operations and may return null if the API doesn't support different languages.

Throws:

java.io.IOException

setLanguage

public void setLanguage(java.lang.String language)

Description copied from interface: OpacApi

Set the language to use. This should be one of the language codes defined in ISO-639-1 (two-letter codes in lower case, see this list). The API should use the default language of the library if this is not called and should fall back first to English and then to the library's default language if the requested language is not available.

Parameters:

language - the language to use

getLanguage

protected java.lang.String getLanguage()