de.geeksfactory.opacclient.apis

Class Pica

java.lang.Object

de.geeksfactory.opacclient.apis.BaseApi

de.geeksfactory.opacclient.apis.Pica

All Implemented Interfaces:

OpacApi

Direct Known Subclasses:

PicaLBS, PicaOld

public abstract class Pica
extends BaseApi
implements OpacApi

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 org.apache.http.client.CookieStore	cookieStore
protected org.json.JSONObject	data
protected java.lang.String	db
protected static java.util.HashMap<java.lang.String,SearchResult.MediaType>	defaulttypes
protected java.lang.String	https_url
protected java.lang.String	languageCode
protected static java.util.HashMap<java.lang.String,java.lang.String>	languageCodes
protected Library	library
protected java.lang.String	lor_reservations
protected java.lang.String	opac_url
protected java.lang.String	pwEncoded
protected int	resultcount
protected java.lang.String	reusehtml
protected java.lang.Integer	searchSet

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, 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
Pica()

Method Summary

Modifier and Type	Method and Description
protected int	addParameters(SearchQuery query, java.util.List<org.apache.http.NameValuePair> params, int index)
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	getDefaultEncoding()
protected java.lang.String	getLang()
SearchResult.MediaType	getMediaTypeInSingleResult(java.lang.String html)
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 lib, HttpClientFactory httpClientFactory) Initializes HTTP client and String Provider
protected DetailledItem	parse_result(java.lang.String html)
protected SearchRequestResult	parse_search(java.lang.String html, int page)
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.
void	updateSearchSetValue(org.jsoup.nodes.Document doc)
SearchRequestResult	volumeSearch(java.util.Map<java.lang.String,java.lang.String> query) Performs a catalogue search for volumes of an item.

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

Methods inherited from class java.lang.Object

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

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

account, cancel, checkAccountData, getSearchFields, prolong, prolongAll, reservation, setStringProvider, start

Field Detail

defaulttypes

protected static java.util.HashMap<java.lang.String,SearchResult.MediaType> defaulttypes

languageCodes

protected static java.util.HashMap<java.lang.String,java.lang.String> languageCodes

opac_url

protected java.lang.String opac_url

https_url

protected java.lang.String https_url

data

protected org.json.JSONObject data

library

protected Library library

resultcount

protected int resultcount

reusehtml

protected java.lang.String reusehtml

searchSet

protected java.lang.Integer searchSet

db

protected java.lang.String db

pwEncoded

protected java.lang.String pwEncoded

languageCode

protected java.lang.String languageCode

cookieStore

protected org.apache.http.client.CookieStore cookieStore

lor_reservations

protected java.lang.String lor_reservations

Constructor Detail

Pica

public Pica()

Method Detail

init

public void init(Library lib,
                 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:

lib - 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.

addParameters

protected int addParameters(SearchQuery query,
                            java.util.List<org.apache.http.NameValuePair> params,
                            int index)
                     throws org.json.JSONException

Throws:

org.json.JSONException

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.

Specified by:

search in interface OpacApi

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

volumeSearch

public SearchRequestResult volumeSearch(java.util.Map<java.lang.String,java.lang.String> query)
                                 throws java.io.IOException,
                                        OpacApi.OpacErrorException

Description copied from interface: OpacApi

Performs a catalogue search for volumes of an item. The query is given to it from DetailledItem.getVolumesearch(). This function is always called from a background thread, you can use blocking network operations in it. See documentation on DetailledItem for details.

Specified by:

volumeSearch in interface OpacApi

Overrides:

volumeSearch in class BaseApi

Parameters:

query - see above

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

parse_search

protected SearchRequestResult parse_search(java.lang.String html,
                                           int page)
                                    throws OpacApi.OpacErrorException

Throws:

OpacApi.OpacErrorException

searchGetPage

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

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.

Specified by:

searchGetPage in interface OpacApi

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

See Also:

OpacApi.search(List), SearchResult

filterResults

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

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.

Specified by:

filterResults in interface OpacApi

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

See Also:

SearchResult, Filter

getResultById

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

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.

Specified by:

getResultById in interface OpacApi

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

See Also:

DetailledItem

getResult

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

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.

Specified by:

getResult in interface OpacApi

Parameters:

position - position of object in last search

Returns:

Media details

Throws:

java.io.IOException

See Also:

DetailledItem

parse_result

protected DetailledItem parse_result(java.lang.String html)

parseSearchFields

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

Specified by:

parseSearchFields in class BaseApi

Throws:

java.io.IOException

org.json.JSONException

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.

Specified by:

getShareUrl in interface OpacApi

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.

Specified by:

getSupportFlags in interface OpacApi

Returns:

combination (bitwise OR) of SUPPORT_FLAG_* constants

updateSearchSetValue

public void updateSearchSetValue(org.jsoup.nodes.Document doc)

getMediaTypeInSingleResult

public SearchResult.MediaType getMediaTypeInSingleResult(java.lang.String html)

getDefaultEncoding

protected java.lang.String getDefaultEncoding()

Overrides:

getDefaultEncoding in class BaseApi

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.

Specified by:

setLanguage in interface OpacApi

Parameters:

language - the language to use

getLang

protected java.lang.String getLang()

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.

Specified by:

getSupportedLanguages in interface OpacApi

Throws:

java.io.IOException