A B C D E F G H I L O P Q R S U V X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addExtraResponseDataParser(SRUExtraResponseDataParser) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Add an extra response data parser instance to the list of extra response data parsers
- addRecordDataParser(SRURecordDataParser) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Add a record data parser instance to the list of record data parsers
B
- build() - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Create a configuration instance object for configuring SRU clients
- Builder() - Constructor for class eu.clarin.sru.client.SRUClientConfig.Builder
-
Constructor.
C
- canScan() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index
- canSearch() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index
- canSort() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index
- consumeStart(XMLStreamReader) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- consumeWhitespace(XMLStreamReader) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- createAuthenticationHeaderValue(SRUOperation, String) - Method in interface eu.clarin.sru.client.SRURequestAuthenticator
-
Make an HTTP Authentication header value for a SRU request.
D
- DEFAULT_CONNECT_TIMEOUT - Static variable in class eu.clarin.sru.client.SRUClientConfig
-
default connect timeout to be used, if not otherwise specified
- DEFAULT_SOCKET_TIMEOUT - Static variable in class eu.clarin.sru.client.SRUClientConfig
-
default socket timeout to be used, if not otherwise specified
- DEFAULT_SRU_VERSION - Static variable in class eu.clarin.sru.client.SRUClientConfig
-
default version the client will use, if not otherwise specified
- DIAG_NO_RECORD_PARSER - Static variable in class eu.clarin.sru.client.SRUClientDiagnostics
-
No record parser was found for this record schema.
- DIAG_RECORD_PARSER_NULL - Static variable in class eu.clarin.sru.client.SRUClientDiagnostics
-
The record parser erroneously returned a null pointer instead of a record data object.
E
- eu.clarin.sru.client - package eu.clarin.sru.client
- explain(SRUExplainRequest) - Method in class eu.clarin.sru.client.SRUClient
-
Perform a explain operation.
- explain(SRUExplainRequest) - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Deprecated.Use asynchronous callback interface
SRUThreadedClient.explain(SRUExplainRequest, SRUCallback)
. This method will be removed in the future. - explain(SRUExplainRequest, SRUCallback<SRUExplainRequest, SRUExplainResponse>) - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Perform a explain operation and invoke a user supplied callback after the request has been completed.
- explain(SRUExplainRequest, SRUExplainHandler) - Method in class eu.clarin.sru.client.SRUSimpleClient
-
Perform a explain operation.
- EXPLAIN - eu.clarin.sru.client.SRUOperation
-
A explain operation
F
- finalize() - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Invokes
shutdown
when this no longer referenced - FIRST - eu.clarin.sru.client.SRUWhereInList
-
The first term (first)
G
- getAuthor() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getConfigInfo() - Method in class eu.clarin.sru.client.SRUExplainRecordData
- getConnectTimeout() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get the connect timeout.
- getContact() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getCustomizedHttpClient() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get the customized HTTP client which is to be used.
- getDatabase() - Method in class eu.clarin.sru.client.SRUExplainRecordData.ServerInfo
- getDatabaseInfo() - Method in class eu.clarin.sru.client.SRUExplainRecordData
- getDefaults() - Method in class eu.clarin.sru.client.SRUExplainRecordData.ConfigInfo
- getDefaultVersion() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get default SRU version to be used.
- getDescription() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getDetails() - Method in class eu.clarin.sru.client.SRUDiagnostic
-
Get supplementary information for this diagnostic.
- getDetails() - Method in class eu.clarin.sru.client.SRUSurrogateRecordData
-
Convenience method to get supplementary information for this diagnostic.
- getDiagnostic() - Method in class eu.clarin.sru.client.SRUSurrogateRecordData
-
Get the surrogate diagnostic.
- getDisplayTerm() - Method in class eu.clarin.sru.client.SRUTerm
-
Get A string to display to the end user in place of the term itself.
- getDocumentFragment() - Method in class eu.clarin.sru.client.SRUGenericExtraResponseData
-
Get the parsed extra response data as DocumentFragment
- getExtend() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getExtraRecordData() - Method in class eu.clarin.sru.client.SRURecord
-
Get extra record data attached to this record.
- getExtraResponseDataParsers() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get the list of extra response data parsers to be used.
- getExtraTermData() - Method in class eu.clarin.sru.client.SRUTerm
-
Get extra term data for this term.
- getHistory() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getHost() - Method in class eu.clarin.sru.client.SRUExplainRecordData.ServerInfo
- getHttpClientContext() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get the HTTP client context which is to be used.
- getId() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index
- getIdentifier() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Set
- getIdentifier() - Method in class eu.clarin.sru.client.SRUExplainRecordData.Schema
- getImplementation() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getIndexes() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo
- getIndexInfo() - Method in class eu.clarin.sru.client.SRUExplainRecordData
- getLang() - Method in class eu.clarin.sru.client.SRUExplainRecordData.LocalizedString
- getLangUsage() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getLinks() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getLocation() - Method in class eu.clarin.sru.client.SRUExplainRecordData.Schema
- getMaps() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index
- getMaximumRecords() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Get the value of the maximumRecords argument for this request.
- getMaximumTerms() - Method in class eu.clarin.sru.client.SRUScanRequest
-
Get the value of the maximumTerms argument for this request.
- getMessage() - Method in class eu.clarin.sru.client.SRUDiagnostic
-
Get human readable message.
- getMessage() - Method in class eu.clarin.sru.client.SRUSurrogateRecordData
-
Convenience method to get human readable message.
- getName() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index.Map
- getName() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Set
- getName() - Method in class eu.clarin.sru.client.SRUExplainRecordData.Schema
- getNextRecordPosition() - Method in class eu.clarin.sru.client.SRUSearchRetrieveResponse
-
Get the next record position.
- getNumberOfRecords() - Method in class eu.clarin.sru.client.SRUSearchRetrieveResponse
-
Get the number of records.
- getNumberOfRecords() - Method in class eu.clarin.sru.client.SRUTerm
-
Get the number of records which would me matched by the term.
- getOperation() - Method in class eu.clarin.sru.client.SRUExplainRequest
- getOperation() - Method in class eu.clarin.sru.client.SRUScanRequest
- getOperation() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
- getPort() - Method in class eu.clarin.sru.client.SRUExplainRecordData.ServerInfo
- getQuery() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Get the value of the query argument for this request.
- getQueryType() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
(SRU 2.0) Get the value of the queryType argument for this request.
- getRecord() - Method in class eu.clarin.sru.client.SRUExplainResponse
-
Get the explain record.
- getRecordData() - Method in class eu.clarin.sru.client.SRURecord
-
Get the record.
- getRecordDataParsers() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get the list of record data parsers to be used.
- getRecordIdentifier() - Method in class eu.clarin.sru.client.SRURecord
-
Get the record identifier (only SRU version 1.2).
- getRecordPacking() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Get the recordPacking (SRU 2.0) parameter of this request.
- getRecordPosition() - Method in class eu.clarin.sru.client.SRURecord
-
Get the record position in the result set.
- getRecords() - Method in class eu.clarin.sru.client.SRUSearchRetrieveResponse
-
Get the list of records.
- getRecordSchema() - Method in class eu.clarin.sru.client.SRUExplainRecordData
- getRecordSchema() - Method in class eu.clarin.sru.client.SRURecord
-
The record schema for this record.
- getRecordSchema() - Method in interface eu.clarin.sru.client.SRURecordData
-
The record schema for this record.
- getRecordSchema() - Method in interface eu.clarin.sru.client.SRURecordDataParser
-
The record schema this parser is able to process.
- getRecordSchema() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Get the value of the recordSchema argument for this request.
- getRecordSchema() - Method in class eu.clarin.sru.client.SRUSurrogateRecordData
- getRecordsCount() - Method in class eu.clarin.sru.client.SRUSearchRetrieveResponse
-
Get the number of records returned by the request.
- getRecordXmlEscaping() - Method in class eu.clarin.sru.client.SRUExplainRequest
-
Get the recordXmlEscpaing (SRU 2.0) or recordPacking (SRU 1.1 and SRU 1.2) parameter of this request.
- getRecordXmlEscaping() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Get the recordXmlEscpaing (SRU 2.0) or recordPacking (SRU 1.1 and SRU 1.2) parameter of this request.
- getRequestAuthenticator() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get the request authenticator
- getResponsePosition() - Method in class eu.clarin.sru.client.SRUScanRequest
-
Get the value of the responsePosition argument for this request.
- getRestrictions() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getResultSetId() - Method in class eu.clarin.sru.client.SRUSearchRetrieveResponse
-
Get the result set id.
- getResultSetIdleTime() - Method in class eu.clarin.sru.client.SRUSearchRetrieveResponse
-
Get the result set idle time.
- getResultSetTTL() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Get the value of the resultSetTTL argument for this request.
- getRetrieve() - Method in class eu.clarin.sru.client.SRUExplainRecordData.Schema
- getRootElement() - Method in interface eu.clarin.sru.client.SRUExtraResponseData
-
The QName of a chuck of extra response data.
- getRootElement() - Method in class eu.clarin.sru.client.SRUGenericExtraResponseData
- getScanClause() - Method in class eu.clarin.sru.client.SRUScanRequest
-
Get the value of the scanClause argument for this request.
- getSchemaInfo() - Method in class eu.clarin.sru.client.SRUExplainRecordData
- getServerInfo() - Method in class eu.clarin.sru.client.SRUExplainRecordData
- getSet() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index.Map
- getSets() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo
- getSettings() - Method in class eu.clarin.sru.client.SRUExplainRecordData.ConfigInfo
- getSocketTimeout() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get the socket timeout.
- getSort() - Method in class eu.clarin.sru.client.SRUExplainRecordData.Schema
- getStartRecord() - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Get the value of the startRecord argument for this request.
- getSubjects() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getSupports() - Method in class eu.clarin.sru.client.SRUExplainRecordData.ConfigInfo
- getTerms() - Method in class eu.clarin.sru.client.SRUScanResponse
-
Get list of terms matched by the request.
- getTermsCount() - Method in class eu.clarin.sru.client.SRUScanResponse
-
Get the number of terms returned by the request.
- getThreadCount() - Method in class eu.clarin.sru.client.SRUClientConfig
-
Get the number of worker threads.
- getTitle() - Method in class eu.clarin.sru.client.SRUExplainRecordData.DatabaseInfo
- getTitle() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index
- getTitle() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Set
- getTitle() - Method in class eu.clarin.sru.client.SRUExplainRecordData.Schema
- getTransport() - Method in class eu.clarin.sru.client.SRUExplainRecordData.ServerInfo
- getURI() - Method in class eu.clarin.sru.client.SRUDiagnostic
-
Get diagnostic's identifying URI.
- getURI() - Method in class eu.clarin.sru.client.SRUSurrogateRecordData
-
Convenience method to get diagnostic's identifying URI.
- getValue() - Method in class eu.clarin.sru.client.SRUExplainRecordData.LocalizedString
- getValue() - Method in class eu.clarin.sru.client.SRUTerm
-
Get the term as it appeared in the index.
- getVersion() - Method in class eu.clarin.sru.client.SRUExplainRecordData.ServerInfo
- getVersionNumber() - Method in enum eu.clarin.sru.client.SRUVersion
-
Get a numerical representation of the version.
- getWhereInList() - Method in class eu.clarin.sru.client.SRUTerm
-
Get the flag to indicate the position of the term within the complete term list.
H
- hasExtraRecordData() - Method in class eu.clarin.sru.client.SRURecord
-
Check, if this record has extra record data attached to it.
- hasExtraTermData() - Method in class eu.clarin.sru.client.SRUTerm
-
Check, if this term has extra term data attached to it.
- hasRecord() - Method in class eu.clarin.sru.client.SRUExplainResponse
-
Check, if response contains a record.
- hasRecords() - Method in class eu.clarin.sru.client.SRUSearchRetrieveResponse
-
Check, if response contains any records.
- hasTerms() - Method in class eu.clarin.sru.client.SRUScanResponse
-
Check, if response contains any terms.
I
- INNER - eu.clarin.sru.client.SRUWhereInList
-
Any other term (inner)
- isParseRecordDataEnabled() - Method in class eu.clarin.sru.client.SRUExplainRequest
-
Check, whether the record data of a explain response (ZeeRex record) shall be parsed or not.
- isPrimary() - Method in class eu.clarin.sru.client.SRUExplainRecordData.IndexInfo.Index.Map
- isPrimary() - Method in class eu.clarin.sru.client.SRUExplainRecordData.LocalizedString
- isRecordSchema(String) - Method in class eu.clarin.sru.client.SRURecord
-
Check if this record is in a certain record schema.
- isTransient() - Method in class eu.clarin.sru.client.SRUExplainRecordData
- isTransient() - Method in interface eu.clarin.sru.client.SRURecordData
-
This record is transient.
- isTransient() - Method in class eu.clarin.sru.client.SRUSurrogateRecordData
- isVersion(SRUVersion) - Method in enum eu.clarin.sru.client.SRUVersion
- isVersion(SRUVersion, SRUVersion) - Method in enum eu.clarin.sru.client.SRUVersion
L
- LAST - eu.clarin.sru.client.SRUWhereInList
-
The last term (last)
O
- onDiagnostics(List<SRUDiagnostic>) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onDiagnostics(List<SRUDiagnostic>) - Method in interface eu.clarin.sru.client.SRUExplainHandler
-
Receive notification of diagnostics.
- onDiagnostics(List<SRUDiagnostic>) - Method in interface eu.clarin.sru.client.SRUScanHandler
-
Receive notification of diagnostics.
- onDiagnostics(List<SRUDiagnostic>) - Method in interface eu.clarin.sru.client.SRUSearchRetrieveHandler
-
Receive notification of diagnostics.
- onError(V, SRUClientException) - Method in interface eu.clarin.sru.client.SRUCallback
-
Invoked when the request yielded an error
- onExtraRecordData(String, int, XMLStreamReader) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onExtraRecordData(String, int, XMLStreamReader) - Method in interface eu.clarin.sru.client.SRUExplainHandler
-
Receive notification of extra record data.
- onExtraRecordData(String, int, XMLStreamReader) - Method in interface eu.clarin.sru.client.SRUSearchRetrieveHandler
-
Receive notification of extra record data.
- onExtraResponseData(XMLStreamReader) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onExtraResponseData(XMLStreamReader) - Method in interface eu.clarin.sru.client.SRUExplainHandler
-
Receive notification of extra response data.
- onExtraResponseData(XMLStreamReader) - Method in interface eu.clarin.sru.client.SRUScanHandler
-
Receive notification of extra response data.
- onExtraResponseData(XMLStreamReader) - Method in interface eu.clarin.sru.client.SRUSearchRetrieveHandler
-
Receive notification of extra response data.
- onExtraTermData(String, XMLStreamReader) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onExtraTermData(String, XMLStreamReader) - Method in interface eu.clarin.sru.client.SRUScanHandler
-
Receive notification of extra term data.
- onFinishRecords(int) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onFinishRecords(int) - Method in interface eu.clarin.sru.client.SRUExplainHandler
-
Receive notifications of the end of the enumeration of records in the response.
- onFinishRecords(int) - Method in interface eu.clarin.sru.client.SRUSearchRetrieveHandler
-
Receive notifications of the end of the enumeration of records in the response.
- onFinishTerms() - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onFinishTerms() - Method in interface eu.clarin.sru.client.SRUScanHandler
-
Receive notifications of the end of the enumeration of terms in the response.
- ONLY - eu.clarin.sru.client.SRUWhereInList
-
The only term (only)
- onRecord(String, int, SRURecordData) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onRecord(String, int, SRURecordData) - Method in interface eu.clarin.sru.client.SRUExplainHandler
-
Receive notification of a record in the result set.
- onRecord(String, int, SRURecordData) - Method in interface eu.clarin.sru.client.SRUSearchRetrieveHandler
-
Receive notification of a record in the result set.
- onRequestStatistics(int, long, long, long) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onRequestStatistics(int, long, long, long) - Method in interface eu.clarin.sru.client.SRUExplainHandler
-
Receive notification of request statistics.
- onRequestStatistics(int, long, long, long) - Method in interface eu.clarin.sru.client.SRUScanHandler
-
Receive notification of request statistics.
- onRequestStatistics(int, long, long, long) - Method in interface eu.clarin.sru.client.SRUSearchRetrieveHandler
-
Receive notification of request statistics.
- onStartRecords(int, String, int) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onStartRecords(int, String, int) - Method in interface eu.clarin.sru.client.SRUExplainHandler
-
Receive notifications of the start of the enumeration of records in the response.
- onStartRecords(int, String, int) - Method in interface eu.clarin.sru.client.SRUSearchRetrieveHandler
-
Receive notifications of the start of the enumeration of records in the response.
- onStartTerms() - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onStartTerms() - Method in interface eu.clarin.sru.client.SRUScanHandler
-
Receive notifications of the start of the enumeration of terms in the response.
- onSuccess(S) - Method in interface eu.clarin.sru.client.SRUCallback
-
Invoked when the request has been completed successfully.
- onSurrogateRecord(String, int, SRUDiagnostic) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onSurrogateRecord(String, int, SRUDiagnostic) - Method in interface eu.clarin.sru.client.SRUSearchRetrieveHandler
-
Receive notification of a surrogate record in the result set.
- onTerm(String, int, String, SRUWhereInList) - Method in class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- onTerm(String, int, String, SRUWhereInList) - Method in interface eu.clarin.sru.client.SRUScanHandler
-
Receive notification of a term.
P
- PACKED - eu.clarin.sru.client.SRURecordPacking
-
The client requests that the server should supply records strictly according to the requested schema.
- parse(XMLStreamReader) - Method in interface eu.clarin.sru.client.SRUExtraResponseDataParser
-
Parse the extra response data into a Java object.
- parse(XMLStreamReader) - Method in interface eu.clarin.sru.client.SRURecordDataParser
-
Parse a record data into a Java object.
- parseToDocument(XMLStreamReader) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- peekEnd(XMLStreamReader, String, String) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- peekStart(XMLStreamReader, String, String) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
Q
- QUERY_TYPE_CQL - Static variable in class eu.clarin.sru.client.SRUClientConstants
-
constant for CQL query type
R
- readAttributeValue(XMLStreamReader, String, String) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readAttributeValue(XMLStreamReader, String, String, boolean) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readContent(XMLStreamReader, String, String, boolean) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readContent(XMLStreamReader, String, String, boolean, int) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readEnd(XMLStreamReader, String, String) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readEnd(XMLStreamReader, String, String, boolean) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readNamespaceURI(XMLStreamReader) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readStart(XMLStreamReader, String, String, boolean) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readStart(XMLStreamReader, String, String, boolean, boolean) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- readString(XMLStreamReader, boolean) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- RECORD_DATA_PARSER_SCHEMA_ANY - Static variable in class eu.clarin.sru.client.SRUClientConstants
-
constant record data schema parser to match any schema
- RECORD_SCHEMA - Static variable in class eu.clarin.sru.client.SRUExplainRecordData
- RECORD_SCHEMA - Static variable in class eu.clarin.sru.client.SRUSurrogateRecordData
-
The record schema for SRU surrogate records.
S
- scan(SRUScanRequest) - Method in class eu.clarin.sru.client.SRUClient
-
Perform a scan operation.
- scan(SRUScanRequest) - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Deprecated.Use asynchronous callback interface
SRUThreadedClient.scan(SRUScanRequest, SRUCallback)
. This method will be removed in the future. - scan(SRUScanRequest, SRUCallback<SRUScanRequest, SRUScanResponse>) - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Perform a scan operation and invoke a user supplied callback after the request has been completed.
- scan(SRUScanRequest, SRUScanHandler) - Method in class eu.clarin.sru.client.SRUSimpleClient
-
Perform a scan operation.
- SCAN - eu.clarin.sru.client.SRUOperation
-
A scan operation
- SEARCH_RETRIEVE - eu.clarin.sru.client.SRUOperation
-
A searchRetrieve operation
- searchRetrieve(SRUSearchRetrieveRequest) - Method in class eu.clarin.sru.client.SRUClient
-
Perform a searchRetrieve operation.
- searchRetrieve(SRUSearchRetrieveRequest) - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Deprecated.Use asynchronous callback interface
SRUThreadedClient.searchRetrieve(SRUSearchRetrieveRequest, SRUCallback)
. This method will be removed in the future. - searchRetrieve(SRUSearchRetrieveRequest, SRUCallback<SRUSearchRetrieveRequest, SRUSearchRetrieveResponse>) - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Perform a searchRetrieve operation and invoke a user supplied callback after the request has been completed.
- searchRetrieve(SRUSearchRetrieveRequest, SRUSearchRetrieveHandler) - Method in class eu.clarin.sru.client.SRUSimpleClient
-
Perform a searchRetrieve operation.
- setConnectTimeout(int) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Set the timeout in milliseconds until a connection is established.
- setCustomizedHttpClient(CloseableHttpClient) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Set a customized HTTP client which is to be used.
- setDefaultVersion(SRUVersion) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Set the default SRU version to be used.
- setHttpContext(HttpClientContext) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Optionally set the HTTP context which is to be used by the customized HTTP client.
- setMaximumRecords(int) - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Set the value of the maximumRecords argument for this request.
- setMaximumTerms(int) - Method in class eu.clarin.sru.client.SRUScanRequest
-
Set the value of the maximumTerms argument for this request.
- setParseRecordDataEnabled(boolean) - Method in class eu.clarin.sru.client.SRUExplainRequest
-
Enable or disable parsing of explain record data (ZeeRex record) of the explain response.
- setQuery(String, String) - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Set the value of the queryType (SRU 2.0) and the query argument for this request.
- setRecordPacking(SRURecordPacking) - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Set the recordPacking (SRU 2.0) parameter of this request.
- setRecordSchema(String) - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Set the value of the recordSchema argument for this request.
- setRecordXmlEscaping(SRURecordXmlEscaping) - Method in class eu.clarin.sru.client.SRUExplainRequest
-
Set the recordXmlEscpaing (SRU 2.0) or recordPacking (SRU 1.1 and SRU 1.2) parameter of this request.
- setRecordXmlEscaping(SRURecordXmlEscaping) - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Set the recordXmlEscpaing (SRU 2.0) or recordPacking (SRU 1.1 and SRU 1.2) parameter of this request.
- setRequestAuthenticator(SRURequestAuthenticator) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
- setResponsePosition(int) - Method in class eu.clarin.sru.client.SRUScanRequest
-
Set the value of the responsePosition argument for this request.
- setResultSetTTL(int) - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Set the value of the resultSetTTL argument for this request.
- setScanClause(String) - Method in class eu.clarin.sru.client.SRUScanRequest
-
Set the value of the scanClause argument for this request.
- setSocketTimeout(int) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Set the socket timeout (
SO_TIMEOUT
) in milliseconds, which is the timeout for waiting for data. - setStartRecord(int) - Method in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Set the value of the startRecord argument for this request.
- setThreadCount(int) - Method in class eu.clarin.sru.client.SRUClientConfig.Builder
-
Set the number of worker threads.
- shutdown() - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Initiates an orderly shutdown in which previously submitted requests are executed, but no new requests will be accepted.
- shutdownNow() - Method in class eu.clarin.sru.client.SRUThreadedClient
-
Terminate the client but drain queued requests.
- skipTag(XMLStreamReader, String, String) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- skipTag(XMLStreamReader, String, String, boolean) - Static method in class eu.clarin.sru.client.XmlStreamReaderUtils
- SRUCallback<V extends eu.clarin.sru.client.SRUAbstractRequest,S extends eu.clarin.sru.client.SRUAbstractResponse<V>> - Interface in eu.clarin.sru.client
-
A interface for creating asynchronous callbacks for use with the
SRUThreadedClient
. - SRUClient - Class in eu.clarin.sru.client
-
A client to perform SRU operations.
- SRUClient(SRUClientConfig) - Constructor for class eu.clarin.sru.client.SRUClient
-
Constructor.
- SRUClientConfig - Class in eu.clarin.sru.client
-
A class for encapsulating the configuration of an SRU client.
- SRUClientConfig.Builder - Class in eu.clarin.sru.client
-
A class that implements the builder pattern to create
SRUClientConfig
instances. - SRUClientConstants - Class in eu.clarin.sru.client
-
Some constants for the SRUClient.
- SRUClientDiagnostics - Class in eu.clarin.sru.client
-
Diagnostics defined by SRU client.
- SRUClientException - Exception in eu.clarin.sru.client
-
SRU client exception.
- SRUClientException(String) - Constructor for exception eu.clarin.sru.client.SRUClientException
-
Constructor
- SRUClientException(String, Throwable) - Constructor for exception eu.clarin.sru.client.SRUClientException
-
Constructor
- SRUDefaultHandler - Interface in eu.clarin.sru.client
-
A handler implementing all interfaces for all three response handler types.
- SRUDefaultHandlerAdapter - Class in eu.clarin.sru.client
-
Default base class for SRU client response handlers.
- SRUDefaultHandlerAdapter() - Constructor for class eu.clarin.sru.client.SRUDefaultHandlerAdapter
- SRUDiagnostic - Class in eu.clarin.sru.client
-
Class to hold a SRU diagnostic.
- SRUDiagnostic(String, String, String) - Constructor for class eu.clarin.sru.client.SRUDiagnostic
-
Constructor.
- SRUExplainHandler - Interface in eu.clarin.sru.client
-
Receive notifications to the response of a explain request.
- SRUExplainRecordData - Class in eu.clarin.sru.client
-
A record data implementation for SRU explain record data conforming to the ZeeRex schema.
- SRUExplainRecordData.ConfigInfo - Class in eu.clarin.sru.client
- SRUExplainRecordData.DatabaseInfo - Class in eu.clarin.sru.client
- SRUExplainRecordData.IndexInfo - Class in eu.clarin.sru.client
- SRUExplainRecordData.IndexInfo.Index - Class in eu.clarin.sru.client
- SRUExplainRecordData.IndexInfo.Index.Map - Class in eu.clarin.sru.client
- SRUExplainRecordData.IndexInfo.Set - Class in eu.clarin.sru.client
- SRUExplainRecordData.LocalizedString - Class in eu.clarin.sru.client
- SRUExplainRecordData.Schema - Class in eu.clarin.sru.client
- SRUExplainRecordData.ServerInfo - Class in eu.clarin.sru.client
- SRUExplainRequest - Class in eu.clarin.sru.client
-
An object for performing a explain operation.
- SRUExplainRequest(String) - Constructor for class eu.clarin.sru.client.SRUExplainRequest
-
Constructor.
- SRUExplainRequest(URI) - Constructor for class eu.clarin.sru.client.SRUExplainRequest
-
Constructor.
- SRUExplainResponse - Class in eu.clarin.sru.client
-
A response to a explain request.
- SRUExtraResponseData - Interface in eu.clarin.sru.client
-
Interface for parsed extra response data objects.
- SRUExtraResponseDataParser - Interface in eu.clarin.sru.client
-
A parser to parse extra response data in a SRU response create appropriate Java objects.
- SRUGenericExtraResponseData - Class in eu.clarin.sru.client
-
A class that provides a generic implementation for
SRUExtraResponseData
. - SRUOperation - Enum in eu.clarin.sru.client
-
SRU operation.
- SRURecord - Class in eu.clarin.sru.client
-
Class for holding a single record from a result set.
- SRURecordData - Interface in eu.clarin.sru.client
-
Interface for parsed record data objects.
- SRURecordDataParser - Interface in eu.clarin.sru.client
-
A parser to parse record data and create appropriate Java objects.
- SRURecordPacking - Enum in eu.clarin.sru.client
-
SRU 2.0 record packing.
- SRURecordXmlEscaping - Enum in eu.clarin.sru.client
-
SRU record packing
- SRURequestAuthenticator - Interface in eu.clarin.sru.client
- SRUScanHandler - Interface in eu.clarin.sru.client
-
Receive notifications to the response of a scan request.
- SRUScanRequest - Class in eu.clarin.sru.client
-
An object for performing a explain operation.
- SRUScanRequest(String) - Constructor for class eu.clarin.sru.client.SRUScanRequest
-
Constructor.
- SRUScanRequest(URI) - Constructor for class eu.clarin.sru.client.SRUScanRequest
-
Constructor.
- SRUScanResponse - Class in eu.clarin.sru.client
-
A response to a scan request.
- SRUSearchRetrieveHandler - Interface in eu.clarin.sru.client
-
Receive notifications to the response of a searchRetrieve request.
- SRUSearchRetrieveRequest - Class in eu.clarin.sru.client
-
An object for performing a searchRetrieve operation.
- SRUSearchRetrieveRequest(String) - Constructor for class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Constructor.
- SRUSearchRetrieveRequest(URI) - Constructor for class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
Constructor.
- SRUSearchRetrieveResponse - Class in eu.clarin.sru.client
-
A response to a searchRetrieve request.
- SRUSimpleClient - Class in eu.clarin.sru.client
-
A simple client to perform SRU operations using callbacks.
- SRUSimpleClient(SRUClientConfig) - Constructor for class eu.clarin.sru.client.SRUSimpleClient
-
Constructor.
- SRUSurrogateRecordData - Class in eu.clarin.sru.client
-
A record data implementation to hold surrogate diagnostics.
- SRUTerm - Class in eu.clarin.sru.client
-
Class to hold a single entry from a scan response.
- SRUThreadedClient - Class in eu.clarin.sru.client
-
A client to perform SRU operations in parallel.
- SRUThreadedClient(SRUClientConfig) - Constructor for class eu.clarin.sru.client.SRUThreadedClient
-
Constructor.
- SRUVersion - Enum in eu.clarin.sru.client
-
SRU version
- SRUWhereInList - Enum in eu.clarin.sru.client
-
A flag to indicate the position of the term within the complete term list.
- STRING - eu.clarin.sru.client.SRURecordXmlEscaping
-
String record packing
- supports(QName) - Method in interface eu.clarin.sru.client.SRUExtraResponseDataParser
-
Check, if the current element can be handled by this parser.
U
- UNPACKED - eu.clarin.sru.client.SRURecordPacking
-
The server is free to allow the location of application data to vary within the record.
V
- valueOf(String) - Static method in enum eu.clarin.sru.client.SRUOperation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum eu.clarin.sru.client.SRURecordPacking
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum eu.clarin.sru.client.SRURecordXmlEscaping
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum eu.clarin.sru.client.SRUVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum eu.clarin.sru.client.SRUWhereInList
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum eu.clarin.sru.client.SRUOperation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum eu.clarin.sru.client.SRURecordPacking
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum eu.clarin.sru.client.SRURecordXmlEscaping
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum eu.clarin.sru.client.SRUVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum eu.clarin.sru.client.SRUWhereInList
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VERSION_1_1 - eu.clarin.sru.client.SRUVersion
-
SRU/CQL version 1.1
- VERSION_1_2 - eu.clarin.sru.client.SRUVersion
-
SRU/CQL version 1.2
- VERSION_2_0 - eu.clarin.sru.client.SRUVersion
-
SRU/CQL version 2.0
X
- X_INDENT_RESPONSE - Static variable in class eu.clarin.sru.client.SRUClientConstants
-
constant for extra request parameter "x-indent-response" (NB: only applicable for SRUServer implementation)
- X_MALFORMED_MAXIMUM_RECORDS - Static variable in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
for end-point conformance testing only.
- X_MALFORMED_MAXIMUM_TERMS - Static variable in class eu.clarin.sru.client.SRUScanRequest
-
for end-point conformance testing only.
- X_MALFORMED_QUERY - Static variable in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
for end-point conformance testing only.
- X_MALFORMED_RECORD_XML_ESCAPING - Static variable in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
for end-point conformance testing only.
- X_MALFORMED_RESPONSE_POSITION - Static variable in class eu.clarin.sru.client.SRUScanRequest
-
for end-point conformance testing only.
- X_MALFORMED_SCAN_CLAUSE - Static variable in class eu.clarin.sru.client.SRUScanRequest
-
for end-point conformance testing only.
- X_MALFORMED_START_RECORD - Static variable in class eu.clarin.sru.client.SRUSearchRetrieveRequest
-
for end-point conformance testing only.
- X_UNLIMITED_RESULTSET - Static variable in class eu.clarin.sru.client.SRUClientConstants
-
constant for extra request parameter "x-unlimited-resultset" (NB: only applicable for SRUServer implementation)
- X_UNLIMITED_TERMLIST - Static variable in class eu.clarin.sru.client.SRUClientConstants
-
constant for extra request parameter "x-unlimited-termlist" (NB: only applicable for SRUServer implementation)
- XML - eu.clarin.sru.client.SRURecordXmlEscaping
-
XML record packing
- XmlStreamReaderUtils - Class in eu.clarin.sru.client
-
Helper class for dealing with
XMLStreamReader
.
All Classes All Packages