de.geeksfactory.opacclient.apis

Class Primo

java.lang.Object

de.geeksfactory.opacclient.apis.BaseApi

de.geeksfactory.opacclient.apis.Primo

All Implemented Interfaces:

OpacApi

public class Primo
extends BaseApi

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.json.JSONObject	data
protected java.lang.String	languageCode
protected static java.util.HashMap<java.lang.String,java.lang.String>	languageCodes
protected java.util.List<SearchQuery>	last_query
protected static java.util.HashMap<java.lang.String,SearchResult.MediaType>	mediaTypeClasses
protected java.lang.String	opac_url
protected java.lang.String	vid

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
Primo()

Method Summary

Modifier and Type	Method and Description
AccountData	account(Account account) Load account view (borrowed and reserved items, see AccountData) This function is always called from a background thread, you can use blocking network operations in it.
protected java.util.List<org.apache.http.NameValuePair>	buildSearchParams(java.util.List<SearchQuery> query)
OpacApi.CancelResult	cancel(java.lang.String media, Account account, int useraction, java.lang.String selection) Cancel a media reservation/order identified by the given String (see AccountData documentation) (see AccountData) This function is always called from a background thread, you can use blocking network operations in it.
void	checkAccountData(Account account) Check the validity of given account data.
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()
static java.util.Map<java.lang.String,java.lang.String>	getQueryParamsFirst(java.lang.String url)
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.
java.lang.String	httpGet(java.lang.String url, java.lang.String encoding, boolean ignore_errors, org.apache.http.client.CookieStore cookieStore) Perform a HTTP GET request to a given URL
void	init(Library lib, HttpClientFactory httpClientFactory) Initializes HTTP client and String Provider
protected DetailledItem	parse_detail(java.lang.String id, org.jsoup.nodes.Document doc)
protected SearchRequestResult	parse_search(org.jsoup.nodes.Document doc, int page)
java.util.List<SearchField>	parseSearchFields()
OpacApi.ProlongResult	prolong(java.lang.String media, Account account, int useraction, java.lang.String selection) Extend the lending period of the item identified by the given String (see AccountData) This function is always called from a background thread, you can use blocking network operations in it.
OpacApi.ProlongAllResult	prolongAll(Account account, int useraction, java.lang.String selection) Extend the lending period of all lent items.
OpacApi.ReservationResult	reservation(DetailledItem item, Account account, int useraction, java.lang.String selection) Perform a reservation on the item last fetched with getResultById or getResult for Account acc.
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	start() May be called on application startup and you are free to call it in our OpacApi.search(java.util.List<de.geeksfactory.opacclient.searchfields.SearchQuery>) implementation or similar positions.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

languageCodes

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

mediaTypeClasses

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

languageCode

protected java.lang.String languageCode

opac_url

protected java.lang.String opac_url

vid

protected java.lang.String vid

data

protected org.json.JSONObject data

last_query

protected java.util.List<SearchQuery> last_query

Constructor Detail

Primo

public Primo()

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.

buildSearchParams

protected java.util.List<org.apache.http.NameValuePair> buildSearchParams(java.util.List<SearchQuery> query)
                                                                   throws java.io.IOException,
                                                                          OpacApi.OpacErrorException

Throws:

java.io.IOException

OpacApi.OpacErrorException

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

parse_search

protected SearchRequestResult parse_search(org.jsoup.nodes.Document doc,
                                           int page)
                                    throws OpacApi.OpacErrorException,
                                           java.io.IOException

Throws:

OpacApi.OpacErrorException

java.io.IOException

getQueryParamsFirst

public static java.util.Map<java.lang.String,java.lang.String> getQueryParamsFirst(java.lang.String url)

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

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

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

parse_detail

protected DetailledItem parse_detail(java.lang.String id,
                                     org.jsoup.nodes.Document doc)
                              throws OpacApi.OpacErrorException,
                                     java.io.IOException

Throws:

OpacApi.OpacErrorException

java.io.IOException

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

start

public void start()
           throws java.io.IOException

Description copied from interface: OpacApi

May be called on application startup and you are free to call it in our OpacApi.search(java.util.List<de.geeksfactory.opacclient.searchfields.SearchQuery>) implementation or similar positions. It is commonly used to initialize a session. You MUST NOT rely on it being called and should check by yourself, whether it was already called (if your following calls require it to be called before). You SHOULD use this function to populate the MetaDataSource e.g. with information on your library's branches. This function is always called from a background thread, you can use blocking network operations in it.

Specified by:

start in interface OpacApi

Overrides:

start in class BaseApi

Throws:

java.io.IOException - if network connection failed

NotReachableException - may throw this if the library couldn't be reached

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

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

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.

Parameters:

language - the language to use

reservation

public OpacApi.ReservationResult reservation(DetailledItem item,
                                             Account account,
                                             int useraction,
                                             java.lang.String selection)
                                      throws java.io.IOException

Description copied from interface: OpacApi

Perform a reservation on the item last fetched with getResultById or getResult for Account acc. (if applicable) This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

item - The item to place a reservation for.

account - Account to be used

useraction - Identifier for the selection made by the user in selection, if a selection was made (see OpacApi.MultiStepResult.getActionIdentifier()) or 0, if no selection was required. If your last method call returned CONFIRMATION_NEEDED, this is set to ACTION_CONFIRMATION if the user positively confirmed the action.

selection - When the method is called for the first time or if useraction is ACTION_CONFIRMATION, this parameter is null. If you return SELECTION in your OpacApi.MultiStepResult.getStatus(), this method will be called again with the user's selection present in selection.

Returns:

A ReservationResult object which has to have the status set.

Throws:

java.io.IOException

prolong

public OpacApi.ProlongResult prolong(java.lang.String media,
                                     Account account,
                                     int useraction,
                                     java.lang.String selection)
                              throws java.io.IOException

Description copied from interface: OpacApi

Extend the lending period of the item identified by the given String (see AccountData) This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

media - Media identification

account - Account to be used

useraction - Identifier for the selection made by the user in selection, if a selection was made (see OpacApi.MultiStepResult.getActionIdentifier()) or 0, if no selection was required. If your last method call returned CONFIRMATION_NEEDED, this is set to ACTION_CONFIRMATION if the user positively confirmed the action.

selection - When the method is called for the first time or if useraction is ACTION_CONFIRMATION, this parameter is null. If you return SELECTION in your OpacApi.MultiStepResult.getStatus(), this method will be called again with the user's selection present in selection.

Returns:

A ProlongResult object which has to have the status set.

Throws:

java.io.IOException

prolongAll

public OpacApi.ProlongAllResult prolongAll(Account account,
                                           int useraction,
                                           java.lang.String selection)
                                    throws java.io.IOException

Description copied from interface: OpacApi

Extend the lending period of all lent items. Will only be called if your OpacApi.getSupportFlags() implementation's return value contains the OpacApi.SUPPORT_FLAG_ACCOUNT_PROLONG_ALL flag. If you don't support the feature, just implement a stub method, like return false; This function is always called from a background thread, you can use blocking network operations in it.

Returns:

A ProlongAllResult object which has to have the status set.

Throws:

java.io.IOException

See Also:

OpacApi.prolong(String, Account, int, String), AccountData

cancel

public OpacApi.CancelResult cancel(java.lang.String media,
                                   Account account,
                                   int useraction,
                                   java.lang.String selection)
                            throws java.io.IOException,
                                   OpacApi.OpacErrorException

Description copied from interface: OpacApi

Cancel a media reservation/order identified by the given String (see AccountData documentation) (see AccountData) This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

media - Media identification

account - Account to be used

useraction - Identifier for the selection made by the user in selection, if a selection was made (see OpacApi.MultiStepResult.getActionIdentifier()) or 0, if no selection was required. If your last method call returned CONFIRMATION_NEEDED, this is set to ACTION_CONFIRMATION if the user positively confirmed the action.

selection - When the method is called for the first time or if useraction is ACTION_CONFIRMATION, this parameter is null. If you return SELECTION in your OpacApi.MultiStepResult.getStatus(), this method will be called again with the user's selection present in selection.

Returns:

A CancelResult object which has to have the status set.

Throws:

java.io.IOException

OpacApi.OpacErrorException

account

public AccountData account(Account account)
                    throws java.io.IOException,
                           org.json.JSONException,
                           OpacApi.OpacErrorException

Description copied from interface: OpacApi

Load account view (borrowed and reserved items, see AccountData) This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

account - The account to display

Returns:

Account details

Throws:

java.io.IOException

org.json.JSONException

OpacApi.OpacErrorException

See Also:

AccountData

checkAccountData

public void checkAccountData(Account account)
                      throws java.io.IOException,
                             org.json.JSONException,
                             OpacApi.OpacErrorException

Description copied from interface: OpacApi

Check the validity of given account data. This is separate from the OpacApi.account(Account) function because just checking the login can be much faster than retrieving all the account data. This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

account - The account to check

Throws:

OpacApi.OpacErrorException - when the login data is invalid or there's another error message from the OPAC system

java.io.IOException

org.json.JSONException

httpGet

public java.lang.String httpGet(java.lang.String url,
                                java.lang.String encoding,
                                boolean ignore_errors,
                                org.apache.http.client.CookieStore cookieStore)
                         throws java.io.IOException

Description copied from class: BaseApi

Perform a HTTP GET request to a given URL

Overrides:

httpGet in class BaseApi

Parameters:

url - URL to fetch

encoding - Expected encoding of the response body

ignore_errors - If true, status codes above 400 do not raise an exception

cookieStore - If set, the given cookieStore is used instead of the built-in one.

Returns:

Answer content

Throws:

NotReachableException - Thrown when server returns a HTTP status code greater or equal than 400.

java.io.IOException