Reference¶
- clarin.sru.constants
SRUOperation
SRUQueryType
SRURecordPacking
SRURecordXmlEscaping
SRURenderBy
SRUResultCountPrecision
SRUVersion
SRUDiagnostics
SRUDiagnostics.nr
SRUDiagnostics.category
SRUDiagnostics.description
SRUDiagnostics.GENERAL_SYSTEM_ERROR
SRUDiagnostics.SYSTEM_TEMPORARILY_UNAVAILABLE
SRUDiagnostics.AUTHENTICATION_ERROR
SRUDiagnostics.UNSUPPORTED_OPERATION
SRUDiagnostics.UNSUPPORTED_VERSION
SRUDiagnostics.UNSUPPORTED_PARAMETER_VALUE
SRUDiagnostics.MANDATORY_PARAMETER_NOT_SUPPLIED
SRUDiagnostics.UNSUPPORTED_PARAMETER
SRUDiagnostics.DATABASE_DOES_NOT_EXIST
SRUDiagnostics.QUERY_SYNTAX_ERROR
SRUDiagnostics.TOO_MANY_CHARACTERS_IN_QUERY
SRUDiagnostics.INVALID_OR_UNSUPPORTED_USE_OF_PARENTHESES
SRUDiagnostics.INVALID_OR_UNSUPPORTED_USE_OF_QUOTES
SRUDiagnostics.UNSUPPORTED_CONTEXT_SET
SRUDiagnostics.UNSUPPORTED_INDEX
SRUDiagnostics.UNSUPPORTED_COMBINATION_OF_INDEXES
SRUDiagnostics.UNSUPPORTED_RELATION
SRUDiagnostics.UNSUPPORTED_RELATION_MODIFIER
SRUDiagnostics.UNSUPPORTED_COMBINATION_OF_RELATION_MODIFERS
SRUDiagnostics.UNSUPPORTED_COMBINATION_OF_RELATION_AND_INDEX
SRUDiagnostics.TOO_MANY_CHARACTERS_IN_TERM
SRUDiagnostics.UNSUPPORTED_COMBINATION_OF_RELATION_AND_TERM
SRUDiagnostics.NON_SPECIAL_CHARACTER_ESCAPED_IN_TERM
SRUDiagnostics.EMPTY_TERM_UNSUPPORTED
SRUDiagnostics.MASKING_CHARACTER_NOT_SUPPORTED
SRUDiagnostics.MASKED_WORDS_TOO_SHORT
SRUDiagnostics.TOO_MANY_MASKING_CHARACTERS_IN_TERM
SRUDiagnostics.ANCHORING_CHARACTER_NOT_SUPPORTED
SRUDiagnostics.ANCHORING_CHARACTER_IN_UNSUPPORTED_POSITION
SRUDiagnostics.COMBINATION_OF_PROXIMITY_ADJACENCY_AND_MASKING_CHARACTERS_NOT_SUPPORTED
SRUDiagnostics.COMBINATION_OF_PROXIMITY_ADJACENCY_AND_ANCHORING_CHARACTERS_NOT_SUPPORTED
SRUDiagnostics.TERM_CONTAINS_ONLY_STOPWORDS
SRUDiagnostics.TERM_IN_INVALID_FORMAT_FOR_INDEX_OR_RELATION
SRUDiagnostics.UNSUPPORTED_BOOLEAN_OPERATOR
SRUDiagnostics.TOO_MANY_BOOLEAN_OPERATORS_IN_QUERY
SRUDiagnostics.PROXIMITY_NOT_SUPPORTED
SRUDiagnostics.UNSUPPORTED_PROXIMITY_RELATION
SRUDiagnostics.UNSUPPORTED_PROXIMITY_DISTANCE
SRUDiagnostics.UNSUPPORTED_PROXIMITY_UNIT
SRUDiagnostics.UNSUPPORTED_PROXIMITY_ORDERING
SRUDiagnostics.UNSUPPORTED_COMBINATION_OF_PROXIMITY_MODIFIERS
SRUDiagnostics.UNSUPPORTED_BOOLEAN_MODIFIER
SRUDiagnostics.CANNOT_PROCESS_QUERY_REASON_UNKNOWN
SRUDiagnostics.QUERY_FEATURE_UNSUPPORTED
SRUDiagnostics.MASKING_CHARACTER_IN_UNSUPPORTED_POSITION
SRUDiagnostics.RESULT_SETS_NOT_SUPPORTED
SRUDiagnostics.RESULT_SET_DOES_NOT_EXIST
SRUDiagnostics.RESULT_SET_TEMPORARILY_UNAVAILABLE
SRUDiagnostics.RESULT_SETS_ONLY_SUPPORTED_FOR_RETRIEVAL
SRUDiagnostics.COMBINATION_OF_RESULT_SETS_WITH_SEARCH_TERMS_NOT_SUPPORTED
SRUDiagnostics.RESULT_SET_CREATED_WITH_UNPREDICTABLE_PARTIAL_RESULTS_AVAILABLE
SRUDiagnostics.RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE
SRUDiagnostics.RESULT_SET_NOT_CREATED_TOO_MANY_MATCHING_RECORDS
SRUDiagnostics.FIRST_RECORD_POSITION_OUT_OF_RANGE
SRUDiagnostics.RECORD_TEMPORARILY_UNAVAILABLE
SRUDiagnostics.RECORD_DOES_NOT_EXIST
SRUDiagnostics.UNKNOWN_SCHEMA_FOR_RETRIEVAL
SRUDiagnostics.RECORD_NOT_AVAILABLE_IN_THIS_SCHEMA
SRUDiagnostics.NOT_AUTHORISED_TO_SEND_RECORD
SRUDiagnostics.NOT_AUTHORISED_TO_SEND_RECORD_IN_THIS_SCHEMA
SRUDiagnostics.RECORD_TOO_LARGE_TO_SEND
SRUDiagnostics.UNSUPPORTED_XML_ESCAPING_VALUE
SRUDiagnostics.XPATH_RETRIEVAL_UNSUPPORTED
SRUDiagnostics.XPATH_EXPRESSION_CONTAINS_UNSUPPORTED_FEATURE
SRUDiagnostics.UNABLE_TO_EVALUATE_XPATH_EXPRESSION
SRUDiagnostics.SORT_NOT_SUPPORTED
SRUDiagnostics.UNSUPPORTED_SORT_SEQUENCE
SRUDiagnostics.TOO_MANY_RECORDS_TO_SORT
SRUDiagnostics.TOO_MANY_SORT_KEYS_TO_SORT
SRUDiagnostics.CANNOT_SORT_INCOMPATIBLE_RECORD_FORMATS
SRUDiagnostics.UNSUPPORTED_SCHEMA_FOR_SORT
SRUDiagnostics.UNSUPPORTED_PATH_FOR_SORT
SRUDiagnostics.PATH_UNSUPPORTED_FOR_SCHEMA
SRUDiagnostics.UNSUPPORTED_DIRECTION
SRUDiagnostics.UNSUPPORTED_CASE
SRUDiagnostics.UNSUPPORTED_MISSING_VALUE_ACTION
SRUDiagnostics.SORT_ENDED_DUE_TO_MISSING_VALUE
SRUDiagnostics.SORT_SPEC_INCLUDED_BOTH_IN_QUERY_AND_PROTOCOL_QUERY_PREVAILS
SRUDiagnostics.SORT_SPEC_INCLUDED_BOTH_IN_QUERY_AND_PROTOCOL_PROTOCOL_PREVAILS
SRUDiagnostics.SORT_SPEC_INCLUDED_BOTH_IN_QUERY_AND_PROTOCOL_ERROR
SRUDiagnostics.STYLESHEETS_NOT_SUPPORTED
SRUDiagnostics.UNSUPPORTED_STYLESHEET
SRUDiagnostics.RESPONSE_POSITION_OUT_OF_RANGE
SRUDiagnostics.TOO_MANY_TERMS_REQUESTED
SRUDiagnostics.get_by_uri()
SRUParam
SRUParam.OPERATION
SRUParam.VERSION
SRUParam.STYLESHEET
SRUParam.RENDER_BY
SRUParam.HTTP_ACCEPT
SRUParam.RESPONSE_TYPE
SRUParam.QUERY
SRUParam.QUERY_TYPE
SRUParam.START_RECORD
SRUParam.MAXIMUM_RECORDS
SRUParam.RECORD_XML_ESCAPING
SRUParam.RECORD_PACKING
SRUParam.RECORD_SCHEMA
SRUParam.RECORD_XPATH
SRUParam.RESULT_SET_TTL
SRUParam.SORT_KEYS
SRUParam.SCAN_CLAUSE
SRUParam.RESPONSE_POSITION
SRUParam.MAXIMUM_TERMS
SRUParam.X_UNLIMITED_RESULTSET
SRUParam.X_UNLIMITED_TERMLIST
SRUParam.X_INDENT_RESPONSE
SRUParamValue
SRUParamValue.OP_EXPLAIN
SRUParamValue.OP_SCAN
SRUParamValue.OP_SEARCH_RETRIEVE
SRUParamValue.VERSION_1_1
SRUParamValue.VERSION_1_2
SRUParamValue.RECORD_XML_ESCAPING_XML
SRUParamValue.RECORD_XML_ESCAPING_STRING
SRUParamValue.RECORD_PACKING_PACKED
SRUParamValue.RECORD_PACKING_UNPACKED
SRUParamValue.RENDER_BY_CLIENT
SRUParamValue.RENDER_BY_SERVER
- clarin.sru.diagnostic
- clarin.sru.exception
- clarin.sru.queryparser
- clarin.sru.server.auth
- clarin.sru.server.config
LegacyNamespaceMode
LocalizedString
SRUServerConfigKey
SRUServerConfigKey.SRU_SUPPORTED_VERSION_MIN
SRUServerConfigKey.SRU_SUPPORTED_VERSION_MAX
SRUServerConfigKey.SRU_SUPPORTED_VERSION_DEFAULT
SRUServerConfigKey.SRU_LEGACY_NAMESPACE_MODE
SRUServerConfigKey.SRU_TRANSPORT
SRUServerConfigKey.SRU_HOST
SRUServerConfigKey.SRU_PORT
SRUServerConfigKey.SRU_DATABASE
SRUServerConfigKey.SRU_NUMBER_OF_RECORDS
SRUServerConfigKey.SRU_MAXIMUM_RECORDS
SRUServerConfigKey.SRU_NUMBER_OF_TERMS
SRUServerConfigKey.SRU_MAXIMUM_TERMS
SRUServerConfigKey.SRU_ECHO_REQUESTS
SRUServerConfigKey.SRU_INDENT_RESPONSE
SRUServerConfigKey.SRU_ALLOW_OVERRIDE_MAXIMUM_RECORDS
SRUServerConfigKey.SRU_ALLOW_OVERRIDE_MAXIMUM_TERMS
SRUServerConfigKey.SRU_ALLOW_OVERRIDE_INDENT_RESPONSE
SRUServerConfigKey.SRU_RESPONSE_BUFFER_SIZE
DatabaseInfo
SchemaInfo
IndexInfo
SRUServerConfig
SRUServerConfig.min_version
SRUServerConfig.max_version
SRUServerConfig.default_version
SRUServerConfig.legacy_namespace_mode
SRUServerConfig.transport
SRUServerConfig.host
SRUServerConfig.port
SRUServerConfig.database
SRUServerConfig.number_of_records
SRUServerConfig.maximum_records
SRUServerConfig.number_of_terms
SRUServerConfig.maximum_terms
SRUServerConfig.echo_requests
SRUServerConfig.indent_response
SRUServerConfig.response_buffer_size
SRUServerConfig.allow_override_maximum_records
SRUServerConfig.allow_override_maximum_terms
SRUServerConfig.allow_override_indent_response
SRUServerConfig.base_url
SRUServerConfig.database_info
SRUServerConfig.index_info
SRUServerConfig.schema_info
SRUServerConfig.default_record_xml_escaping
SRUServerConfig.default_record_packing
SRUServerConfig.get_record_schema_identifier()
SRUServerConfig.get_record_schema_name()
SRUServerConfig.find_schema_info()
SRUServerConfig.find_set_by_name()
SRUServerConfig.fromparams()
SRUServerConfig.parse()
SRUServerConfig.load_config_file()
SRUServerConfig.parse_version()
SRUServerConfig.parse_int()
SRUServerConfig.parse_bool()
- clarin.sru.server.request
SRURequest
SRURequest.get_operation()
SRURequest.get_version()
SRURequest.is_version()
SRURequest.is_version_between()
SRURequest.get_record_xml_escaping()
SRURequest.get_record_packing()
SRURequest.get_query()
SRURequest.get_query_type()
SRURequest.is_query_type()
SRURequest.get_start_record()
SRURequest.get_maximum_records()
SRURequest.get_record_schema_identifier()
SRURequest.get_record_xpath()
SRURequest.get_resultSet_TTL()
SRURequest.get_sortKeys()
SRURequest.get_scan_clause()
SRURequest.get_response_position()
SRURequest.get_maximum_terms()
SRURequest.get_stylesheet()
SRURequest.get_renderBy()
SRURequest.get_response_type()
SRURequest.get_http_accept()
SRURequest.get_protocol_schema()
SRURequest.get_extra_request_data_names()
SRURequest.get_extra_request_data()
ParameterInfo
ParameterInfo.Parameter
ParameterInfo.Parameter.STYLESHEET
ParameterInfo.Parameter.RENDER_BY
ParameterInfo.Parameter.HTTP_ACCEPT
ParameterInfo.Parameter.RESPONSE_TYPE
ParameterInfo.Parameter.START_RECORD
ParameterInfo.Parameter.MAXIMUM_RECORDS
ParameterInfo.Parameter.RECORD_XML_ESCAPING
ParameterInfo.Parameter.RECORD_PACKING
ParameterInfo.Parameter.RECORD_SCHEMA
ParameterInfo.Parameter.RECORD_XPATH
ParameterInfo.Parameter.RESULT_SET_TTL
ParameterInfo.Parameter.SORT_KEYS
ParameterInfo.Parameter.SCAN_CLAUSE
ParameterInfo.Parameter.RESPONSE_POSITION
ParameterInfo.Parameter.MAXIMUM_TERMS
ParameterInfo.parameter
ParameterInfo.mandatory
ParameterInfo.min
ParameterInfo.max
ParameterInfo.name()
ParameterInfo.is_for_version()
ParameterInfoSets
SRURequestImpl
SRURequestImpl.get_request()
SRURequestImpl.get_operation()
SRURequestImpl.get_version()
SRURequestImpl.get_authentication()
SRURequestImpl.get_authentication_subject()
SRURequestImpl.get_query()
SRURequestImpl.get_record_xml_escaping()
SRURequestImpl.get_record_packing()
SRURequestImpl.get_start_record()
SRURequestImpl.get_maximum_records()
SRURequestImpl.get_record_schema_identifier()
SRURequestImpl.get_record_xpath()
SRURequestImpl.get_resultSet_TTL()
SRURequestImpl.get_sortKeys()
SRURequestImpl.get_scan_clause()
SRURequestImpl.get_response_position()
SRURequestImpl.get_maximum_terms()
SRURequestImpl.get_stylesheet()
SRURequestImpl.get_renderBy()
SRURequestImpl.get_response_type()
SRURequestImpl.get_version_raw()
SRURequestImpl.get_record_xml_escaping_raw()
SRURequestImpl.get_record_packing_raw()
SRURequestImpl.get_record_schema_identifier_raw()
SRURequestImpl.get_query_raw()
SRURequestImpl.get_maximum_records_raw()
SRURequestImpl.get_scan_clause_raw()
SRURequestImpl.get_http_accept_raw()
SRURequestImpl.get_indent_response()
SRURequestImpl.get_http_accept()
SRURequestImpl.get_protocol_schema()
SRURequestImpl.add_diagnostic()
SRURequestImpl.add_diagnostic_obj()
SRURequestImpl.check_parameters()
SRURequestImpl.check_parameters_version_operation()
SRURequestImpl.get_parameter_names()
SRURequestImpl.get_parameter()
SRURequestImpl.get_extra_request_data_names()
SRURequestImpl.get_extra_request_data()
- clarin.sru.server.result
SRUAbstractResult
SRUExplainResult
SRUScanResultSet
SRUSearchResultSet
SRUSearchResultSet.get_total_record_count()
SRUSearchResultSet.get_record_count()
SRUSearchResultSet.get_resultSet_id()
SRUSearchResultSet.get_resultSet_TTL()
SRUSearchResultSet.get_result_count_precision()
SRUSearchResultSet.get_record_schema_identifier()
SRUSearchResultSet.next_record()
SRUSearchResultSet.get_record_identifier()
SRUSearchResultSet.get_surrogate_diagnostic()
SRUSearchResultSet.write_record()
SRUSearchResultSet.has_extra_record_data
SRUSearchResultSet.write_extra_record_data()
- clarin.sru.server.server
SRUNamespaces
SRUNamespaces.response_NS
SRUNamespaces.response_prefix
SRUNamespaces.scan_NS
SRUNamespaces.scan_prefix
SRUNamespaces.diagnostic_NS
SRUNamespaces.XCQL_NS
SRUNamespaces.diagnostic_prefix
SRUNamespaces.explain_NS
SRUNamespaces.explain_prefix
SRUNamespaces.for_legacy_LOC()
SRUNamespaces.for_1_2_OASIS()
SRUNamespaces.for_2_0()
SRUNamespaces.get_namespaces()
SRUSearchEngine
SRUServer
- clarin.sru.server.wsgi
- clarin.sru.xml.writer
SRUXMLStreamWriter
SRUXMLStreamWriter.IndentingState
SRUXMLStreamWriter.onStartElement()
SRUXMLStreamWriter.onEndElement()
SRUXMLStreamWriter.onEmptyElement()
SRUXMLStreamWriter.doIndent()
SRUXMLStreamWriter.startRecord()
SRUXMLStreamWriter.endRecord()
SRUXMLStreamWriter.setDocumentLocator()
SRUXMLStreamWriter.startPrefixMapping()
SRUXMLStreamWriter.endPrefixMapping()
SRUXMLStreamWriter.processingInstruction()
SRUXMLStreamWriter.startDocument()
SRUXMLStreamWriter.endDocument()
SRUXMLStreamWriter.startElement()
SRUXMLStreamWriter.endElement()
SRUXMLStreamWriter.startElementNS()
SRUXMLStreamWriter.endElementNS()
SRUXMLStreamWriter.characters()
SRUXMLStreamWriter.ignorableWhitespace()
SRUXMLStreamWriter.skippedEntity()
SRUXMLStreamWriter.writeXCQL()
SRUXMLStreamWriter.prefix()
SRUXMLStreamWriter.element()
SRUXMLStreamWriter.elementcontent()
SRUXMLStreamWriter.record()
copy_XML_into_writer()
XMLStreamWriterHelper
XMLStreamWriterHelper.setDocumentLocator()
XMLStreamWriterHelper.startPrefixMapping()
XMLStreamWriterHelper.endPrefixMapping()
XMLStreamWriterHelper.processingInstruction()
XMLStreamWriterHelper.startDocument()
XMLStreamWriterHelper.endDocument()
XMLStreamWriterHelper.startElement()
XMLStreamWriterHelper.endElement()
XMLStreamWriterHelper.startElementNS()
XMLStreamWriterHelper.endElementNS()
XMLStreamWriterHelper.characters()
XMLStreamWriterHelper.ignorableWhitespace()
XMLStreamWriterHelper.skippedEntity()
XMLStreamWriterHelper.writeXML()
XMLStreamWriterHelper.writeXMLdocument()
XMLStreamWriterHelper.prefix()
XMLStreamWriterHelper.element()
XMLStreamWriterHelper.elementcontent()
XMLStreamWriterHelper.startRecord()
XMLStreamWriterHelper.endRecord()
XMLStreamWriterHelper.record()