A B C D E F G H I L M N O P Q R S T U V X

A

add(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalResourceRepository

Retrieves all OpenSearch resources, whose XML representations are contained in a directory with a given path and adds them to the repository

add(OpenSearchResource) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalResourceRepository

Adds a pre-processed OpenSearchResource to the repository

addTransformation(String, String, String, URL, Map<String, String>) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Adds a transformation specification to the OpenSearch resource

addURL(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalResourceRepository

Adds an OpenSearch resource whose XML representation is retrieved through a URL to the repository

B

BasicQueryBuilder - Class in org.gcube.opensearch.opensearchlibrary.query

Query builder class that implements the QueryBuilder interface, providing standard OpenSearch parameter functionality.

BasicQueryBuilder(URLTemplate, String, String) - Constructor for class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Creates a new BasicQueryBuilder operating on a URL template, with default values for startIndex and startPage OpenSearch parameters (typically provided from the URL element which encloses the URL template)

BasicQueryBuilder(URLTemplate, String, String, String) - Constructor for class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Creates a new BasicQueryBuilder.

BasicQueryElement - Class in org.gcube.opensearch.opensearchlibrary.queryelements

Query element class implementing the QueryElement interface, which provides standard OpenSearch query element functionality

BasicQueryElement(Element) - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Creates a new instance

BasicQueryElementFactory - Class in org.gcube.opensearch.opensearchlibrary.queryelements

A factory class for the construction of BasicQueryElement objects

BasicQueryElementFactory() - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElementFactory

BasicURLElement - Class in org.gcube.opensearch.opensearchlibrary.urlelements

URL element class implementing the URLElement interface, which provides standard OpenSearch URL element functionality

BasicURLElement(Element, Map<String, String>) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

Creates a new BasicURLElement

BasicURLElementFactory - Class in org.gcube.opensearch.opensearchlibrary.urlelements

A factory class for the construction of BasicURLElement objects

BasicURLElementFactory() - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElementFactory

BasicURLTemplate - Class in org.gcube.opensearch.opensearchlibrary.query

Class implementing the URLTemplate interface

BasicURLTemplate(String, Map<String, String>) - Constructor for class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate

Creates a new BasicURLTemplate object

BasicURLTemplate.Parameter - Class in org.gcube.opensearch.opensearchlibrary.query

Class representing a query parameter, containing the qualified name of the parameter and information about whether the parameter is required or not

BasicURLTemplate.Parameter() - Constructor for class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate.Parameter

Creates a new Parameter object

BasicURLTemplate.Parameter(String, boolean) - Constructor for class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate.Parameter

Creates a new Parameter object with a given qualified name and required-optional information

boxQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the box parameter of Geo OpenSearch extensions

C

canRequest() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Determines whether the client may request search results from the OpenSearch provider corresponding to this description document

canSendToClients() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Determines whether the client may send the search results obtained from the OpenSearch provider corresponding to this description document to other search clients

canSendToEndUsers() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Determines whether the client may display the search results obtained from the OpenSearch provider corresponding to this description document to end users

clone() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

clone() - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.geo.GeoQueryBuilder

clone() - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.sru.SRUQueryBuilder

clone() - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.time.TimeQueryBuilder

clone() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Returns a copy of this query builder

clone() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

configNumOfResultsQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

configSequentialResultsQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

containsInfo - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

A common OpenSearch specs violation is for a provider not to include response information in its search query responses.

containsPagingElements() - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Determines whether this search response page contains OpenSearch response information relevant to page handling.

copyFrom(OpenSearchRecordDefinition) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

countQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The qualified name for the count standard OpenSearch parameter

createQueryBuilder(Node, QueryElementFactory, QueryBuilder) - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Adds a QueryBuilder to the list of available query builders after assigning the parameter values contained in the QueryElement and another QueryBuilder

D

defaultCompress - Static variable in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

describesExampleQuery() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Determines whethe the query element describes an example query

describesExampleQuery() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Determines whethe the query element describes an example query

describesExampleQuery() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Determines whethe the query element describes an example query

DescriptionDocument - Class in org.gcube.opensearch.opensearchlibrary

This is the central class of the OpenSearch library, providing functionality related to OpenSearch description documents.

DescriptionDocument(Document, URLElementFactory, QueryElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Creates a new DescriptionDocument instance

descriptionDocuments - Variable in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResourceCache

Associates description document URLs with description document XML representations

dirPath - Variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

The directory to look for resources when operating in local mode

dirPathDef - Static variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

E

el - Variable in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

el - Variable in class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

encodedGeoExtensionsNS - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The namespace of OpenSearch Geo Extensions in URL-encoded form

encodedOpenSearchNS - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The standard OpenSearch namespace in URL-encoded form

encodedSRUExtensionsNS - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The namespace of OpenSearch SRU Extensions in URL-encoded form

encodedTimeExtensionsNS - Static variable in class org.gcube.opensearch.opensearchlibrary.TimeConstants

The namespace of OpenSearch Time Extensions in URL-encoded form

endQname - Static variable in class org.gcube.opensearch.opensearchlibrary.TimeConstants

The qualified name for the end parameter of Time OpenSearch extensions

equals(Object) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate.Parameter

Determines if two Parameter objects are the same.

extendDeflate(DataOutput) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

extendDeflate(DataOutput) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

extendDispose() - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

ExtendedURLElement - Class in org.gcube.opensearch.opensearchlibrary.urlelements

URL element class implementing the URLElement interface, which provides support for extended rel values

ExtendedURLElement(URLElement, Element, Map<String, String>) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElement

Creates a new ExtendedURLElement

ExtendedURLElementFactory - Class in org.gcube.opensearch.opensearchlibrary.urlelements

A factory class for the construction of ExtendedURLElement objects

ExtendedURLElementFactory(URLElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElementFactory

Creates a new instance of the factory

extendEquals(Object) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

extendFromXML(Element) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

extendInflate(DataInput, boolean) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

extendInflate(DataInput) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

extendMakeLocal() - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

extendReceive(DataInput) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

extendReceiveFromXML(Element) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

extendSend(DataOutput) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

extendSendToXML(Document, Element) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

extendToXML(Element) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

F

facetCountQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the facetCount parameter of SRU OpenSearch extensions

facetHighValueQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the facetHighValue parameter of SRU OpenSearch extensions

facetLimitQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the facetLimit parameter of SRU OpenSearch extensions

facetLowValueQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the facetLowValue parameter of SRU OpenSearch extensions

facetRangeFieldQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the facetRangeField parameter of SRU OpenSearch extensions

facetSortQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the facetSort parameter of SRU OpenSearch extensions

facetStartQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the facetStart parameter of SRU OpenSearch extensions

factories - Variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

The factory class names of the implemented factories associated with the namespaces for which they provide functionality A factory associated with the standard OpenSearch namespace is expected to be always present in this mapping

FactoryClassNamePair - Class in org.gcube.opensearch.opensearchlibrary.utils

A utility messenger class containing the class names of a URLElementFactory and a QueryElementFactory

FactoryClassNamePair(String, String) - Constructor for class org.gcube.opensearch.opensearchlibrary.utils.FactoryClassNamePair

Creates a new instance

FactoryClassNamePair(String) - Constructor for class org.gcube.opensearch.opensearchlibrary.utils.FactoryClassNamePair

FactoryPair - Class in org.gcube.opensearch.opensearchlibrary.utils

A utility messenger class containing references to URLElementFactory and a QueryElementFactory

FactoryPair(URLElementFactory, QueryElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.utils.FactoryPair

Creates a new instance

FactoryResolver - Class in org.gcube.opensearch.opensearchlibrary.utils

A utility class that is used to create a pair of URL and Query element factories which respectively construct URLElement and QueryElement instances capable of processing the corresponding URL and query elements.

G

GeoConstants - Class in org.gcube.opensearch.opensearchlibrary

GeoConstants() - Constructor for class org.gcube.opensearch.opensearchlibrary.GeoConstants

GeoExtensionsNS - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The namespace of OpenSearch Geo Extensions

geometryQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the geometry parameter of Geo OpenSearch extensions

GeoQueryBuilder - Class in org.gcube.opensearch.opensearchlibrary.query.extensions.geo

GeoQueryBuilder(QueryBuilder) - Constructor for class org.gcube.opensearch.opensearchlibrary.query.extensions.geo.GeoQueryBuilder

GeoQueryElement - Class in org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo

Query element class implementing the QueryElement interface, which provides functionality for OpenSearch Geo extension query elements

GeoQueryElement(Element, Map<String, String>, QueryElement) - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo.GeoQueryElement

Creates a new instance

GeoQueryElementFactory - Class in org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo

A factory class for the construction of GeoQueryElement objects

GeoQueryElementFactory(QueryElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo.GeoQueryElementFactory

Creates a new instance of the factory

GeoURLElement - Class in org.gcube.opensearch.opensearchlibrary.urlelements.extensions.geo

GeoURLElement(Element, URLElement) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.geo.GeoURLElement

GeoURLElementFactory - Class in org.gcube.opensearch.opensearchlibrary.urlelements.extensions.geo

A factory class for the construction of GeoURLElement objects

GeoURLElementFactory(URLElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.geo.GeoURLElementFactory

Creates a new instance of the factory

get(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.ISResourceRepository

Retrieves an OpenSearchResource identified by the description document URL of the OpenSearch provider associated with it

get(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalResourceRepository

Retrieves an OpenSearchResource identified by the description document URL of the OpenSearch provider associated with it

get(String) - Method in interface org.gcube.opensearch.opensearchoperator.resource.ResourceRepository

Retrieves an OpenSearchResource identified by the description document URL of the OpenSearch provider associated with it

getAttribution() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the String contained in the Attribution element of the description document

getContact() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the String contained in the Contact element of the description document

getCount() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the value of the count OpenSearch parameter contained in the query element

getCount() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the value of the count OpenSearch parameter contained in the query element

getCount() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the value of the count OpenSearch parameter contained in the query element

getCurrentPageResultCount() - Method in class org.gcube.opensearch.opensearchoperator.Pager

Returns the number of results in the current page

getCurrPage() - Method in class org.gcube.opensearch.opensearchoperator.Pager

Returns the current page number

getDefaultInputEncoding() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the default input encoding of the OpenSearch specification

getDefaultOutputEncoding() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the default output encoding of the OpenSearch specification

getDescription() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the String contained in the Description element of the description document

getDescriptionDocument() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves the description document of the OpenSearch provider described by this resource

getDescriptionDocument() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves the description document of the OpenSearch provider described by this resource

getDescriptionDocument() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves the description document of the OpenSearch provider described by this resource

getDescriptionDocURL() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves the URL of the description document of the OpenSearch provider described by this resource

getDescriptionDocURL() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves the URL of the description document of the OpenSearch provider described by this resource

getDescriptionDocURL() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves the URL of the description document of the OpenSearch provider described by this resource

getDeveloper() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the String contained in the Developer element of the description document

getExampleQueryBuilders(String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves a list of all QueryBuilder objects that can be used to send example queries as described in the Query elements of this description document.

getFactories() - Static method in class org.gcube.opensearch.opensearchlibrary.utils.FactoryResolver

getField(String) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

getFinalResultCount() - Method in class org.gcube.opensearch.opensearchoperator.OpenSearchWorker

getFixedParamsMap() - Method in class org.gcube.opensearch.opensearchoperator.QueryParser

Retrieves all fixed parameter name-value mappings

getFixedTerms() - Method in class org.gcube.opensearch.opensearchoperator.QueryParser

Retrieves the fixed parameter corresponding to the searchTerms standard OpenSearch parameter

getHeight() - Method in class org.gcube.opensearch.opensearchlibrary.ImageElement

Returns the image height

getImageURI() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves the URI of the image that appears in the first Image element of this description document

getImageURI(String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves the URI of the image with a specific MIME type appearing first in an Image element of this description document

getIndexOffset() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

Returns the value of the indexOffset OpenSearch parameter contained in this URL element.

getIndexOffset() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElement

Returns the value of the indexOffset OpenSearch parameter contained in this URL element.

getIndexOffset() - Method in interface org.gcube.opensearch.opensearchlibrary.urlelements.URLElement

Returns the value of the indexOffset OpenSearch parameter contained in this URL element.

getIndexOffset() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

Returns the value of the indexOffset OpenSearch parameter contained in this URL element.

getInputEncoding() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the value of the inputEncoding OpenSearch parameter contained in the query element

getInputEncoding() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the value of the inputEncoding OpenSearch parameter contained in the query element

getInputEncoding() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the value of the inputEncoding OpenSearch parameter contained in the query element

getItemsPerPage() - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Returns the number of results per page that are contained in the OpenSearch response

getLanguage() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the value of the language OpenSearch parameter contained in the query element

getLanguage() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the value of the language OpenSearch parameter contained in the query element

getLanguage() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the value of the language OpenSearch parameter contained in the query element

getLocator() - Method in class org.gcube.opensearch.opensearchoperator.OpenSearchWorker

Returns the locator of the output

getLongName() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the String contained in the LongName element of the description document

getMimeType() - Method in class org.gcube.opensearch.opensearchlibrary.ImageElement

Returns the MIME type of the image

getMimeType() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

Retrieves the MIME type associated with the results obtained after issuing a query using the template contained in this URL element

getMimeType() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElement

Retrieves the MIME type associated with the results obtained after issuing a query using the template contained in this URL element

getMimeType() - Method in interface org.gcube.opensearch.opensearchlibrary.urlelements.URLElement

Retrieves the MIME type associated with the results obtained after issuing a query using the template contained in this URL element

getMimeType() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

Retrieves the MIME type associated with the results obtained after issuing a query using the template contained in this URL element

getName() - Method in exception org.gcube.opensearch.opensearchlibrary.query.MalformedQueryException

Retrieves the name of the parameter related to the error

getName() - Method in exception org.gcube.opensearch.opensearchlibrary.query.NonExistentParameterException

Retrieves the name of the parameter related to the error

getName() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Returns the name of the OpenSearch provider

getName() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Returns the name of the OpenSearch provider

getName() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Returns the name of the OpenSearch provider

getNamespaces() - Method in class org.gcube.opensearch.opensearchoperator.QueryParser

Retrieves all namespaces present in the OpenSearch query and the fixed parameters

getNSPrefix(String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves the namespace prefix associated with a namespace URI in the description document

getNSPrefixToURIMappings() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

getNSUrl(String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves the namespace URI associated with a namespace prefix in the description document

getOptionalParameters() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Returns a list containing all optional parameters of the query builder

getOptionalParameters() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate

Returns a list containing the qualified names of all optional parameters contained in the template

getOptionalParameters() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Returns a list containing all optional parameters of the query builder

getOptionalParameters() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Returns a list containing all optional parameters of the query builder

getOptionalParameters() - Method in interface org.gcube.opensearch.opensearchlibrary.query.URLTemplate

Returns a list containing the qualified names of all optional parameters contained in the template

getOutputEncoding() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the value of the outputEncoding OpenSearch parameter contained in the query element

getOutputEncoding() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the value of the outputEncoding OpenSearch parameter contained in the query element

getOutputEncoding() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the value of the outputEncoding OpenSearch parameter contained in the query element

getPageOffset() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

Returns the value of the pageOffset OpenSearch parameter contained in this URL element.

getPageOffset() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElement

Returns the value of the pageOffset OpenSearch parameter contained in this URL element.

getPageOffset() - Method in interface org.gcube.opensearch.opensearchlibrary.urlelements.URLElement

Returns the value of the pageOffset OpenSearch parameter contained in this URL element.

getPageOffset() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

Returns the value of the pageOffset OpenSearch parameter contained in this URL element.

getPageQuery() - Method in class org.gcube.opensearch.opensearchoperator.Pager

Returns a query for the current page of search results using a query builder among the ones available

getParameterQName(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

getParameterQName(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

getParameterQName(String) - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves the fully qualified name of an OpenSearch parameter which corresponds to a field

getParameters() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

getParameters() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

getParameters() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieved the full mapping from field names to fully ns-qualified OpenSearch parameters as contained in the OpenSearch Resource

getParameterValue(String) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Retrieves the value assigned to a parameter of the query builder

getParameterValue(String) - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Retrieves the value assigned to a parameter of the query builder

getParameterValue(String) - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Retrieves the value assigned to a parameter of the query builder

getParams() - Method in class org.gcube.opensearch.opensearchoperator.QueryParser

Retrieves all parameter name-value mappings

getPayload() - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

getPresentationInformation(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves the presentation information, that is, a mapping from field names to XPath expressions

getPresentationInformation(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves the presentation information, that is, a mapping from field names to XPath expressions

getPresentationInformation(String) - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves the presentation information, that is, a mapping from field names to XPath expressions

getQuery() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Retrieves the search query corresponding to the current state of the query builder

getQuery() - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.geo.GeoQueryBuilder

Retrieves the search query corresponding to the current state of the query builder

getQuery() - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.sru.SRUQueryBuilder

Retrieves the search query corresponding to the current state of the query builder

getQuery() - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.time.TimeQueryBuilder

Retrieves the search query corresponding to the current state of the query builder

getQuery() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Retrieves the search query corresponding to the current state of the query builder

getQuery() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Retrieves the search query corresponding to the current state of the query builder

getQueryBuilder() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

Constructs and returns a QueryBuilder object that can be used to construct queries based on the template contained in this query element.

getQueryBuilder() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElement

Constructs and returns a QueryBuilder object that can be used to construct queries based on the template contained in this query element.

getQueryBuilder() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.geo.GeoURLElement

Constructs and returns a QueryBuilder object that can be used to construct queries based on the template contained in this query element.

getQueryBuilder() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.sru.SRUURLElement

Constructs and returns a QueryBuilder object that can be used to construct queries based on the template contained in this query element.

getQueryBuilder() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.time.TimeURLElement

Constructs and returns a QueryBuilder object that can be used to construct queries based on the template contained in this query element.

getQueryBuilder() - Method in interface org.gcube.opensearch.opensearchlibrary.urlelements.URLElement

Constructs and returns a QueryBuilder object that can be used to construct queries based on the template contained in this query element.

getQueryBuilder() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

Constructs and returns a QueryBuilder object that can be used to construct queries based on the template contained in this query element.

getQueryBuilder() - Method in class org.gcube.opensearch.opensearchoperator.Pager

Returns the query builder used to construct queries

getQueryBuilders(String, String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves a list of QueryBuilder objects that can be used to construct queries for resources related to a specific role and which return results of a given MIME type

getQueryBuilders(String) - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Returns a list of QueryBuilder objects that may be used to construct queries for a specific role

getQueryParameters() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns all parameters contained in the query element along with their corresponding values

getQueryParameters() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo.GeoQueryElement

Returns all parameters contained in the query element along with their corresponding values

getQueryParameters() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru.SRUQueryElement

Returns all parameters contained in the query element along with their corresponding values

getQueryParameters() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time.TimeQueryElement

Returns all parameters contained in the query element along with their corresponding values

getQueryParameters() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns all parameters contained in the query element along with their corresponding values

getQueryParameters() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns all parameters contained in the query element along with their corresponding values

getRawTemplate() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Returns the query template associated with this query builder

getRawTemplate() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Returns the query template associated with this query builder

getRawTemplate() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Returns the query template associated with this query builder

getRecordIdXPath(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves an XPathExpression that can be used to extract a record id a from a search result record

getRecordIdXPath(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves an XPathExpression that can be used to extract a record id a from a search result record

getRecordIdXPath(String) - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves an XPathExpression that can be used to extract a record id a from a search result record

getRecordSplitXPath(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves an XPathExpression that can be used to split a search result page of a given MIME type to individual records

getRecordSplitXPath(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves an XPathExpression that can be used to split a search result page of a given MIME type to individual records

getRecordSplitXPath(String) - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves an XPathExpression that can be used to split a search result page of a given MIME type to individual records

getRel() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

Returns the role of the resource being described in relation to the description document

getRel() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElement

Returns the role of the resource being described in relation to the description document

getRel() - Method in interface org.gcube.opensearch.opensearchlibrary.urlelements.URLElement

Returns the role of the resource being described in relation to the description document

getRel() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

Returns the role of the resource being described in relation to the description document

getRequiredParameters() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Returns a list containing all required parameters of the query builder

getRequiredParameters() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate

Returns a list containing the qualified names of all required parameters contained in the template

getRequiredParameters() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Returns a list containing all required parameters of the query builder

getRequiredParameters() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Returns a list containing all required parameters of the query builder

getRequiredParameters() - Method in interface org.gcube.opensearch.opensearchlibrary.query.URLTemplate

Returns a list containing the qualified names of all required parameters contained in the template

getResponse() - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Returns the OpenSearch response Document

getRole() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the role of the search request described in the query element

getRole() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the role of the search request described in the query element

getRole() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the role of the search request described in the query element

getSearchTerms() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the value of the searchTerms OpenSearch parameter contained in the query element

getSearchTerms() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the value of the searchTerms OpenSearch parameter contained in the query element

getSearchTerms() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the value of the searchTerms OpenSearch parameter contained in the query element

getSecuritySpecs() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves the security specifications of this OpenSearch provider

getSecuritySpecs() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves the security specifications of this OpenSearch provider

getSecuritySpecs() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves the security specifications of this OpenSearch provider

getShortName() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the String contained in the ShortName element of the description document

getStartIndex() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the value of the startIndex OpenSearch parameter contained in the query element

getStartIndex() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the value of the startIndex OpenSearch parameter contained in the query element

getStartIndex() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the value of the startIndex OpenSearch parameter contained in the query element

getStartIndex() - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Returns the start index of the first result contained in the OpenSearch response

getStartIndexDef() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Returns the default value of the StartIndex OpenSearch parameter associated with this query builder

getStartIndexDef() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Returns the default value of the StartIndex OpenSearch parameter associated with this query builder

getStartIndexDef() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Returns the default value of the StartIndex OpenSearch parameter associated with this query builder

getStartPage() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the value of the startPage OpenSearch parameter contained in the query element

getStartPage() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the value of the startPage OpenSearch parameter contained in the query element

getStartPage() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the value of the startPage OpenSearch parameter contained in the query element

getStartPageDef() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Returns the default value of the StartPage OpenSearch parameter associated with this query builder

getStartPageDef() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Returns the default value of the StartPage OpenSearch parameter associated with this query builder

getStartPageDef() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Returns the default value of the StartPage OpenSearch parameter associated with this query builder

getSupportedInputEncodings() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves a list of all input encodings supported by e OpenSearch provider corresponding to this description document

getSupportedLanguages() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves a list of all languages supported by the OpenSearch provider corresponding to this description document

getSupportedMimeTypes(String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves a list of MIME types supported for constructing queries for a specific role Standard OpenSearch Url rel values are: "results", "suggestion", "self" and "collection"

getSupportedOutputEncodings() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves a list of all output encodings supported by e OpenSearch provider corresponding to this description document

getSyndicationRight() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns the SyndicationRight value contained in the SyndicationRight element of the description document

getTags() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Retrieves a list of all the tags contained in the description document which identify and categorize the search content

getTemplate() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate

Returns the query template

getTemplate() - Method in interface org.gcube.opensearch.opensearchlibrary.query.URLTemplate

Returns the query template

getTerms() - Method in class org.gcube.opensearch.opensearchoperator.QueryParser

Retrieves the search terms, as specified by the searchTerms standard OpenSearch parameter

getTitle() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns a description describing the search request described in the query element

getTitle() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns a description describing the search request described in the query element

getTitle() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns a description describing the search request described in the query element

getTotalResultCount() - Method in class org.gcube.opensearch.opensearchoperator.Pager

Returns the number of results obtained so far

getTotalResults() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Returns the expected number of results that will be returned if the search request contained in the query element were made

getTotalResults() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Returns the expected number of results that will be returned if the search request contained in the query element were made

getTotalResults() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Returns the expected number of results that will be returned if the search request contained in the query element were made

getTotalResults() - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Returns the number of total results contained in the OpenSearchResponse

getTransformationTypes() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves a list of all MIME types for which there exists a transformation specification

getTransformationTypes() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves a list of all MIME types for which there exists a transformation specification

getTransformationTypes() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves a list of all MIME types for which there exists a transformation specification

getTransformer(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves a transformer that can be used to transform the results of a given MIME type that are returned by the provider described by this resource

getTransformer() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Retrieves a transformer that can be used to transform the results of the first MIME type appearing in this OpenSearch resource that are returned by the provider described by this resource

getTransformer(String) - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves a transformer that can be used to transform the results of a given MIME type that are returned by the provider described by this resource

getTransformer() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Retrieves a transformer that can be used to transform the results of the first MIME type appearing in this OpenSearch resource that are returned by the provider described by this resource

getTransformer(String) - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves a transformer that can be used to transform the results of a given MIME type that are returned by the provider described by this resource

getTransformer() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Retrieves a transformer that can be used to transform the results of the first MIME type appearing in this OpenSearch resource that are returned by the provider described by this resource

getUniqueIdentifier() - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

getUniqueTemplates() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Returns all parameter-wise unique templates contained in this description document

getUnsetParameters() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Returns a list containing all parameters to which no value has been assigned

getUnsetParameters() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Returns a list containing all parameters to which no value has been assigned

getUnsetParameters() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Returns a list containing all parameters to which no value has been assigned

getURI() - Method in class org.gcube.opensearch.opensearchlibrary.ImageElement

Returns the URI of the image

getURIToPrefixMappings() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

getWidth() - Method in class org.gcube.opensearch.opensearchlibrary.ImageElement

Returns the image width

H

hasAdultContent() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Determines whether the search results obtained from the OpenSearch provider corresponding to this description document may contain material intended only for adults

hasLangRestriction() - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Determines whether the description document limits the search to a set of supported languages

hasNext() - Method in class org.gcube.opensearch.opensearchoperator.Pager

Determines whether there exist more results available in a next page

hasParameter(String) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Determines if a parameter is contained in the parameter set of the query builder

hasParameter(String) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate

Determines if the template contains a parameter with a given qualified name

hasParameter(String) - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Determines if a parameter is contained in the parameter set of the query builder

hasParameter(String) - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Determines if a parameter is contained in the parameter set of the query builder

hasParameter(String) - Method in interface org.gcube.opensearch.opensearchlibrary.query.URLTemplate

Determines if the template contains a parameter with a given qualified name

HTMLResponse - Class in org.gcube.opensearch.opensearchlibrary.responseelements

Class implementing an OpenSearch HTML response

HTMLResponse(InputStream, String, Map<String, String>) - Constructor for class org.gcube.opensearch.opensearchlibrary.responseelements.HTMLResponse

Creates a new HTMLResponse

httpAcceptCharsetQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the httpAcceptCharset parameter of SRU OpenSearch extensions

httpAcceptEncodingQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the httpAcceptEncoding parameter of SRU OpenSearch extensions

httpAcceptLanguageQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the httpAcceptLanguage parameter of SRU OpenSearch extensions

httpAcceptQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the httpAccept parameter of SRU OpenSearch extensions

httpAcceptRangesQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the httpAcceptRanges parameter of SRU OpenSearch extensions

I

ImageElement - Class in org.gcube.opensearch.opensearchlibrary

Class implementing the functionality of an Image element contained in a DescriptionDocument

ImageElement(Element) - Constructor for class org.gcube.opensearch.opensearchlibrary.ImageElement

Creates a new ImageElement instance

IncompleteQueryException - Exception in org.gcube.opensearch.opensearchlibrary.query

An exception that is thrown when one or more required query parameters are not assigned with a value

IncompleteQueryException() - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.IncompleteQueryException

Creates a new instance

IncompleteQueryException(String) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.IncompleteQueryException

Creates a new instance

IncompleteQueryException(Throwable) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.IncompleteQueryException

Creates a new instance

IncompleteQueryException(String, Throwable) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.IncompleteQueryException

Creates a new instance

initialize(Collection<String>, Map<String, FactoryClassNamePair>) - Static method in class org.gcube.opensearch.opensearchlibrary.utils.FactoryResolver

inputEncodingQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The qualified name for the inputEncoding standard OpenSearch parameter

isBrokered() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Determines whether the provider described by this resource returns brokered results, i.e the results it returns describe other OpenSearch providers

isBrokered() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Determines whether the provider described by this resource returns brokered results, i.e the results it returns describe other OpenSearch providers

isBrokered() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Determines whether the provider described by this resource returns brokered results, i.e the results it returns describe other OpenSearch providers

ISCache - Variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

Resource cache, to be further populated by ISResourceRepository.

isFirstPage - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

isFirstPage() - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Determines whether this page is the first page of search results

isInputEncodingSupported(String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Determines whether a specific input encoding is supported by the OpenSearch provider corresponding to this description document

isLanguageSupported(String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Determines whether a specific language is supported by the OpenSearch provider corresponding to this description document

isLastPage - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

isLastPage() - Method in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

Determines whether this page is the last page of search results

ISOpenSearchResource - Class in org.gcube.opensearch.opensearchoperator.resource

Class implementing the OpenSearchResource interface that processes OpenSearch resources when an InformationSystem is available

ISOpenSearchResource(String, Map<String, String>, Map<String, String>, Map<String, String>, EnvHintCollection) - Constructor for class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Creates a new ISOpenSearchResource with a cache that will be used and further populated

ISOpenSearchResource(String, EnvHintCollection) - Constructor for class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Creates a new ISOpenSearchResource that will not use a cache

ISOpenSearchResourceCache - Class in org.gcube.opensearch.opensearchoperator.resource

A resource cache that caches generic resources, description documents in XML form and OpenSearchResource objects.

ISOpenSearchResourceCache() - Constructor for class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResourceCache

isOutputEncodingSupported(String) - Method in class org.gcube.opensearch.opensearchlibrary.DescriptionDocument

Determines whether a specific output encoding is supported by the OpenSearch provider corresponding to this description document

isParameterRequired(String) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate

Determines if a parameter with a given qualified name is a required parameter

isParameterRequired(String) - Method in interface org.gcube.opensearch.opensearchlibrary.query.URLTemplate

Determines if a parameter with a given qualified name is a required parameter

isParameterSet(String) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Determines if a parameter has an assigned value.

isParameterSet(String) - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Determines if a parameter has an assigned value.

isParameterSet(String) - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Determines if a parameter has an assigned value.

isQueryComplete() - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Determines whether the query is complete and therefore ready to be issued, i.e.

isQueryComplete() - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.geo.GeoQueryBuilder

Determines whether the query is complete and therefore ready to be issued, i.e.

isQueryComplete() - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Determines whether the query is complete and therefore ready to be issued, i.e.

isQueryComplete() - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Determines whether the query is complete and therefore ready to be issued, i.e.

isRelSupported() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

Answers whether the rel value of the URL element can be interpreted by this URL element type

isRelSupported() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElement

Answers whether the rel value of the URL element can be interpreted by this URL element type

isRelSupported() - Method in interface org.gcube.opensearch.opensearchlibrary.urlelements.URLElement

Answers whether the rel value of the URL element can be interpreted by this URL element type

isRelSupported() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

Answers whether the rel value of the URL element can be interpreted by this URL element type

ISResourceRepository - Class in org.gcube.opensearch.opensearchoperator.resource

Class implementing the ResourceRepository interface that is used to retrieve OpenSearch resources utilizing an InformationSystem.

ISResourceRepository(ISOpenSearchResourceCache, EnvHintCollection) - Constructor for class org.gcube.opensearch.opensearchoperator.resource.ISResourceRepository

Creates a new ISResourceRepository

isRoleSupported() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Determines whether the query element supports the query role provided

isRoleSupported() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Determines whether the query element supports the query role provided

isRoleSupported() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Determines whether the query element supports the query role provided

isSecure() - Method in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource

Determines if the provider described by this resource uses a security scheme

isSecure() - Method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Determines if the provider described by this resource uses a security scheme

isSecure() - Method in interface org.gcube.opensearch.opensearchoperator.resource.OpenSearchResource

Determines if the provider described by this resource uses a security scheme

itemsPerPage - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

L

languageQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The qualified name for the language standard OpenSearch parameter

latQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the lat parameter of Geo OpenSearch extensions

LocalOpenSearchResource - Class in org.gcube.opensearch.opensearchoperator.resource

Class implementing the OpenSearchResource interface that processes OpenSearch resources in the absence of an InformationSystem

LocalOpenSearchResource(String, URL, boolean) - Constructor for class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Creates a new LocalOpenSearchResource by directly providing its attributes

LocalOpenSearchResource(File, File) - Constructor for class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Creates a new LocalOpenSearchResource whose XML representation is stored in a file

LocalOpenSearchResource(String, File) - Constructor for class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Creates a new LocalOpenSearchResouce whose XML representation is stored in a String

LocalOpenSearchResource(URL, File) - Constructor for class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

Creates a new LocalOpenSearchResource whose XML representation can be retrieved through a URL

LocalResourceRepository - Class in org.gcube.opensearch.opensearchoperator.resource

Class implementing the ResourceRepository interface that is used to store and retrieve OpenSearch resources in the absence of an InformationSystem

LocalResourceRepository(File) - Constructor for class org.gcube.opensearch.opensearchoperator.resource.LocalResourceRepository

Creates a new LocalResourceRepository

locationStringQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the locationString parameter of Geo OpenSearch extensions

logger - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

lonQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the lon parameter of Geo OpenSearch extensions

M

main(String[]) - Static method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

main(String[]) - Static method in class org.gcube.opensearch.opensearchlibrary.query.extensions.geo.GeoQueryBuilder

main(String[]) - Static method in class org.gcube.opensearch.opensearchlibrary.query.extensions.sru.SRUQueryBuilder

main(String[]) - Static method in class org.gcube.opensearch.opensearchlibrary.query.extensions.time.TimeQueryBuilder

main(String[]) - Static method in class org.gcube.opensearch.opensearchoperator.client.OpenSearchOpClient

main(String[]) - Static method in class org.gcube.opensearch.opensearchoperator.OpenSearchOp

main(String[]) - Static method in class org.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource

MalformedQueryException - Exception in org.gcube.opensearch.opensearchlibrary.query

An exception that is thrown when an error in a query construct is detected, e.g.

MalformedQueryException() - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.MalformedQueryException

Creates a new instance

MalformedQueryException(String) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.MalformedQueryException

Creates a new instance

MalformedQueryException(String, String) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.MalformedQueryException

Creates a new instance

MalformedQueryException(Throwable) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.MalformedQueryException

Creates a new instance

MalformedQueryException(String, Throwable) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.MalformedQueryException

Creates a new instance

maximumRecordsQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the maximumRecords parameter of SRU OpenSearch extensions

N

name - Variable in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate.Parameter

nameQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the name parameter of Geo OpenSearch extensions

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElementFactory

Creates a new QueryElement object

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo.GeoQueryElementFactory

Creates a new QueryElement object

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru.SRUQueryElementFactory

Creates a new QueryElement object

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time.TimeQueryElementFactory

Creates a new QueryElement object

newInstance(Element, Map<String, String>) - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementFactory

Creates a new QueryElement object

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElementFactory

Creates a new URLElement object

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElementFactory

Creates a new URLElement object

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.geo.GeoURLElementFactory

Creates a new URLElement object

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.sru.SRUURLElementFactory

Creates a new URLElement object

newInstance(Element, Map<String, String>) - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.time.TimeURLElementFactory

Creates a new URLElement object

newInstance(Element, Map<String, String>) - Method in interface org.gcube.opensearch.opensearchlibrary.urlelements.URLElementFactory

Creates a new URLElement object

next(OpenSearchResponse, int) - Method in class org.gcube.opensearch.opensearchoperator.Pager

Advances the current page by one

NonExistentParameterException - Exception in org.gcube.opensearch.opensearchlibrary.query

An exception that is thrown when a query parameter is not present

NonExistentParameterException() - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.NonExistentParameterException

Creates a new instance

NonExistentParameterException(String) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.NonExistentParameterException

Creates a new instance

NonExistentParameterException(String, String) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.NonExistentParameterException

Creates a new instance

NonExistentParameterException(Throwable) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.NonExistentParameterException

Creates a new instance

NonExistentParameterException(String, Throwable) - Constructor for exception org.gcube.opensearch.opensearchlibrary.query.NonExistentParameterException

Creates a new instance

nsPrefixes - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

O

objectIdFieldName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The name of the unique identifier field

OpenSearchConfigNS - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

OpenSearchConstants - Class in org.gcube.opensearch.opensearchlibrary

OpenSearch and library-related constants such as namespaces and qualified OpenSearch standard parameters as used in the library

OpenSearchConstants() - Constructor for class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

OpenSearchNS - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The standard OpenSearch namespace

OpenSearchOp - Class in org.gcube.opensearch.opensearchoperator

Operator class used to query and obtain results from an external OpenSearch provider identified by an OpenSearchResource.

OpenSearchOp(OpenSearchResource, String[], EnvHintCollection) - Constructor for class org.gcube.opensearch.opensearchoperator.OpenSearchOp

Creates a new OpenSearchOp using the default configuration specified in OpenSearchOpConfig.

OpenSearchOp(OpenSearchResource, String[], OpenSearchOpConfig, EnvHintCollection) - Constructor for class org.gcube.opensearch.opensearchoperator.OpenSearchOp

Creates a new OpenSearchOp using the configuration specified in the respective argument.

OpenSearchOpClient - Class in org.gcube.opensearch.opensearchoperator.client

A client that can be used to test the OpenSearch operator locally

OpenSearchOpConfig - Class in org.gcube.opensearch.opensearchoperator

Configuration class parameterizing the operation of the OpenSearchOp

OpenSearchOpConfig() - Constructor for class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

No-arg constructor.

OpenSearchOpConfig(Integer, Boolean, Boolean, Map<String, FactoryClassNamePair>) - Constructor for class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

Creates a new OpenSearchOpConfig with values overriding the defaults

OpenSearchRecord - Class in org.gcube.opensearch.opensearchoperator.record

OpenSearchRecord(String) - Constructor for class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

OpenSearchRecord(String, String) - Constructor for class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

OpenSearchRecordDefinition - Class in org.gcube.opensearch.opensearchoperator.record

OpenSearchRecordDefinition() - Constructor for class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

OpenSearchRecordDefinition(boolean) - Constructor for class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

OpenSearchResource - Interface in org.gcube.opensearch.opensearchoperator.resource

Interface of the OpenSearch resource class that contains information pertaining to an OpenSearch provider

OpenSearchResponse - Class in org.gcube.opensearch.opensearchlibrary.responseelements

Class implementing functionality common to all OpenSearch responses

OpenSearchResponse() - Constructor for class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

OpenSearchWorker - Class in org.gcube.opensearch.opensearchoperator

Used to perform the actual OpenSearchOp operations needed to obtain results and to return the locator of the output

OpenSearchWorker(OpenSearchResource, ResourceRepository, OpenSearchOpConfig, String, Map<String, String>, String, Map<String, String>, Set<String>, Object) - Constructor for class org.gcube.opensearch.opensearchoperator.OpenSearchWorker

Creates a new OpenSearchWorker

org.gcube.opensearch.opensearchlibrary - package org.gcube.opensearch.opensearchlibrary

org.gcube.opensearch.opensearchlibrary.query - package org.gcube.opensearch.opensearchlibrary.query

org.gcube.opensearch.opensearchlibrary.query.extensions.geo - package org.gcube.opensearch.opensearchlibrary.query.extensions.geo

org.gcube.opensearch.opensearchlibrary.query.extensions.sru - package org.gcube.opensearch.opensearchlibrary.query.extensions.sru

org.gcube.opensearch.opensearchlibrary.query.extensions.time - package org.gcube.opensearch.opensearchlibrary.query.extensions.time

org.gcube.opensearch.opensearchlibrary.queryelements - package org.gcube.opensearch.opensearchlibrary.queryelements

org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo - package org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo

org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru - package org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru

org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time - package org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time

org.gcube.opensearch.opensearchlibrary.responseelements - package org.gcube.opensearch.opensearchlibrary.responseelements

org.gcube.opensearch.opensearchlibrary.urlelements - package org.gcube.opensearch.opensearchlibrary.urlelements

org.gcube.opensearch.opensearchlibrary.urlelements.extensions.geo - package org.gcube.opensearch.opensearchlibrary.urlelements.extensions.geo

org.gcube.opensearch.opensearchlibrary.urlelements.extensions.sru - package org.gcube.opensearch.opensearchlibrary.urlelements.extensions.sru

org.gcube.opensearch.opensearchlibrary.urlelements.extensions.time - package org.gcube.opensearch.opensearchlibrary.urlelements.extensions.time

org.gcube.opensearch.opensearchlibrary.utils - package org.gcube.opensearch.opensearchlibrary.utils

org.gcube.opensearch.opensearchoperator - package org.gcube.opensearch.opensearchoperator

org.gcube.opensearch.opensearchoperator.client - package org.gcube.opensearch.opensearchoperator.client

org.gcube.opensearch.opensearchoperator.record - package org.gcube.opensearch.opensearchoperator.record

org.gcube.opensearch.opensearchoperator.resource - package org.gcube.opensearch.opensearchoperator.resource

outputEncodingQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The qualified name for the outputEncoding standard OpenSearch parameter

P

Pager - Class in org.gcube.opensearch.opensearchoperator

A pager class that will be used to handle search query paging

Pager(int, int, String, int, int, int) - Constructor for class org.gcube.opensearch.opensearchoperator.Pager

Creates a new Pages

parameters - Variable in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate

parse() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

Processes a query element

parse() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo.GeoQueryElement

Processes a query element

parse() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru.SRUQueryElement

Processes a query element

parse() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time.TimeQueryElement

Processes a query element

parse() - Method in interface org.gcube.opensearch.opensearchlibrary.queryelements.QueryElement

Processes a query element

parse() - Method in class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

Processes a query element

parse() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

Processes a URL element

parse() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.ExtendedURLElement

Processes a URL element

parse() - Method in interface org.gcube.opensearch.opensearchlibrary.urlelements.URLElement

Processes a URL element

parse() - Method in class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

Processes a URL element

PayloadFieldName - Static variable in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecordDefinition

polygonQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the polygon parameter of Geo OpenSearch extensions

Q

qb - Variable in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

query(String) - Method in class org.gcube.opensearch.opensearchoperator.OpenSearchOp

Performs a query in order to obtain results from an OpenSearch provider

QueryBuilder - Interface in org.gcube.opensearch.opensearchlibrary.query

Interface of the query builder class that is used to construct OpenSearch queries using a query template

QueryBuilderDecorator - Class in org.gcube.opensearch.opensearchlibrary.query

QueryBuilderDecorator(QueryBuilder) - Constructor for class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

queryBuilders - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

An association of role values with lists of query builders

QueryElement - Interface in org.gcube.opensearch.opensearchlibrary.queryelements

Interface of the Query Element class that is used to process Query elements contained in a DescriptionDocument

QueryElementDecorator - Class in org.gcube.opensearch.opensearchlibrary.queryelements

QueryElementDecorator(QueryElement) - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.QueryElementDecorator

QueryElementFactory - Interface in org.gcube.opensearch.opensearchlibrary.queryelements

Interface of the factory class used to construct QueryElement objects

queryElementFactoryClass - Variable in class org.gcube.opensearch.opensearchlibrary.utils.FactoryClassNamePair

queryElements - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

queryElFactory - Variable in class org.gcube.opensearch.opensearchlibrary.utils.FactoryPair

QueryParser - Class in org.gcube.opensearch.opensearchoperator

An OpenSearch query parser, responsible for parsing and processing an OpenSearch query and a set of fixed parameters.

QueryParser(String, String[]) - Constructor for class org.gcube.opensearch.opensearchoperator.QueryParser

Creates a new instance and processes the query and fixed parameter strings

queryQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the query parameter of SRU OpenSearch extensions

queryTypeQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the queryType parameter of SRU OpenSearch extensions

R

radiusQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the radius parameter of Geo OpenSearch extensions

recordPackingQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the recordPacking parameter of SRU OpenSearch extensions

recordSchemaQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the recordSchema parameter of SRU OpenSearch extensions

rel - Variable in class org.gcube.opensearch.opensearchlibrary.urlelements.BasicURLElement

renderingQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the rendering parameter of SRU OpenSearch extensions

ResourceRepository - Interface in org.gcube.opensearch.opensearchoperator.resource

A OpenSearchResource repository class used to obtain OpenSearch resources by their description document URL

resources - Variable in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResourceCache

Associates description document URLs with OpenSearchResources

resourcesXML - Variable in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResourceCache

Associates description document URLs with OpenSearchResource XML representations

response - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

resultSetTTLQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the resultSetTTL parameter of SRU OpenSearch extensions

RESULTSNO_EVENT - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

Result estimation events

RESULTSNOFINAL_EVENT - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

resultsPerPage - Variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

The number of results that the operator requests for each page

resultsPerPageDef - Static variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

The default number of results requested per page

role - Variable in class org.gcube.opensearch.opensearchlibrary.queryelements.BasicQueryElement

role - Variable in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.geo.GeoQueryElement

role - Variable in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru.SRUQueryElement

role - Variable in class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time.TimeQueryElement

run() - Method in class org.gcube.opensearch.opensearchoperator.OpenSearchWorker

Performs the operations needed to obtain the requested search results.

S

schemaPath - Variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

The directory to look for a schema defining the OpenSearchResource validation is enabled

schemaPathDef - Static variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

searchTermsQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The qualified name for the searchTerms standard OpenSearch parameter

sequentialResults - Variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

If false, result retrieval from brokered resources is performed by separate threads

sequentialResultsDef - Static variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

The default value for the sequentialResults configuration parameter

setContext(List<QueryBuilder>, String) - Method in class org.gcube.opensearch.opensearchoperator.Pager

Provides the pager with a list of query builders to be used and the type of the search results that the provider returns

setParameter(String, String) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Assigns a string value to a parameter of the query builder

setParameter(String, Integer) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Assigns an integral value to a parameter of the query builder

setParameter(String, String) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.geo.GeoQueryBuilder

Assigns a string value to a parameter of the query builder

setParameter(String, String) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.sru.SRUQueryBuilder

Assigns a string value to a parameter of the query builder

setParameter(String, String) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.time.TimeQueryBuilder

Assigns a string value to a parameter of the query builder

setParameter(String, String) - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Assigns a string value to a parameter of the query builder

setParameter(String, Integer) - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Assigns an integral value to a parameter of the query builder

setParameter(String, String) - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Assigns a string value to a parameter of the query builder

setParameter(String, Integer) - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Assigns an integral value to a parameter of the query builder

setParameters(List<String>, List<Object>) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Assigns to each parameter contained in the list of the first argument the respective value contained in the list of the secord argument

setParameters(QueryElement) - Method in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

Sets all parameters of the query builder that are also contained in the QueryElement provided with the values contained in the QueryElement

setParameters(List<String>, List<Object>) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.geo.GeoQueryBuilder

Assigns to each parameter contained in the list of the first argument the respective value contained in the list of the secord argument

setParameters(QueryElement) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.geo.GeoQueryBuilder

Sets all parameters of the query builder that are also contained in the QueryElement provided with the values contained in the QueryElement

setParameters(List<String>, List<Object>) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.sru.SRUQueryBuilder

Assigns to each parameter contained in the list of the first argument the respective value contained in the list of the secord argument

setParameters(QueryElement) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.sru.SRUQueryBuilder

Sets all parameters of the query builder that are also contained in the QueryElement provided with the values contained in the QueryElement

setParameters(List<String>, List<Object>) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.time.TimeQueryBuilder

Assigns to each parameter contained in the list of the first argument the respective value contained in the list of the secord argument

setParameters(QueryElement) - Method in class org.gcube.opensearch.opensearchlibrary.query.extensions.time.TimeQueryBuilder

Sets all parameters of the query builder that are also contained in the QueryElement provided with the values contained in the QueryElement

setParameters(List<String>, List<Object>) - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Assigns to each parameter contained in the list of the first argument the respective value contained in the list of the secord argument

setParameters(QueryElement) - Method in interface org.gcube.opensearch.opensearchlibrary.query.QueryBuilder

Sets all parameters of the query builder that are also contained in the QueryElement provided with the values contained in the QueryElement

setParameters(List<String>, List<Object>) - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Assigns to each parameter contained in the list of the first argument the respective value contained in the list of the secord argument

setParameters(QueryElement) - Method in class org.gcube.opensearch.opensearchlibrary.query.QueryBuilderDecorator

Sets all parameters of the query builder that are also contained in the QueryElement provided with the values contained in the QueryElement

setPayload(String) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

setUniqueIdentifier(String) - Method in class org.gcube.opensearch.opensearchoperator.record.OpenSearchRecord

sortKeysQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the sortKeys parameter of SRU OpenSearch extensions

SRUConstants - Class in org.gcube.opensearch.opensearchlibrary

SRUConstants() - Constructor for class org.gcube.opensearch.opensearchlibrary.SRUConstants

SRUExtensionsNS - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The namespace of OpenSearch SRU Extensions

SRUQueryBuilder - Class in org.gcube.opensearch.opensearchlibrary.query.extensions.sru

SRUQueryBuilder(QueryBuilder) - Constructor for class org.gcube.opensearch.opensearchlibrary.query.extensions.sru.SRUQueryBuilder

SRUQueryElement - Class in org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru

Query element class implementing the QueryElement interface, which provides functionality for OpenSearch SRU extension query elements

SRUQueryElement(Element, Map<String, String>, QueryElement) - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru.SRUQueryElement

Creates a new instance

SRUQueryElementFactory - Class in org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru

A factory class for the construction of SRUQueryElement objects

SRUQueryElementFactory(QueryElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.sru.SRUQueryElementFactory

Creates a new instance of the factory

SRUURLElement - Class in org.gcube.opensearch.opensearchlibrary.urlelements.extensions.sru

SRUURLElement(Element, URLElement) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.sru.SRUURLElement

SRUURLElementFactory - Class in org.gcube.opensearch.opensearchlibrary.urlelements.extensions.sru

A factory class for the construction of SRUURLElement objects

SRUURLElementFactory(URLElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.sru.SRUURLElementFactory

Creates a new instance of the factory

startIndex - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

startIndexQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The qualified name for the startIndex standard OpenSearch parameter

startPageQName - Static variable in class org.gcube.opensearch.opensearchlibrary.OpenSearchConstants

The qualified name for the startPage standard OpenSearch parameter

startQname - Static variable in class org.gcube.opensearch.opensearchlibrary.TimeConstants

The qualified name for the start parameter of Time OpenSearch extensions

startRecordQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the startRecord parameter of SRU OpenSearch extensions

stylesheetQname - Static variable in class org.gcube.opensearch.opensearchlibrary.SRUConstants

The qualified name for the stylesheet parameter of SRU OpenSearch extensions

SyndicationRight - Enum in org.gcube.opensearch.opensearchlibrary.utils

The values of the SyndicationRight OpenSearch element

T

template - Variable in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

template - Variable in class org.gcube.opensearch.opensearchlibrary.query.BasicURLTemplate

test(OpenSearchResource) - Method in class org.gcube.opensearch.opensearchoperator.OpenSearchOp

TimeConstants - Class in org.gcube.opensearch.opensearchlibrary

TimeConstants() - Constructor for class org.gcube.opensearch.opensearchlibrary.TimeConstants

TimeExtensionsNS - Static variable in class org.gcube.opensearch.opensearchlibrary.TimeConstants

The namespace of OpenSearch Time Extensions

TimeQueryBuilder - Class in org.gcube.opensearch.opensearchlibrary.query.extensions.time

TimeQueryBuilder(QueryBuilder) - Constructor for class org.gcube.opensearch.opensearchlibrary.query.extensions.time.TimeQueryBuilder

TimeQueryElement - Class in org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time

Query element class implementing the QueryElement interface, which provides functionality for OpenSearch Geo extension query elements

TimeQueryElement(Element, Map<String, String>, QueryElement) - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time.TimeQueryElement

Creates a new instance

TimeQueryElementFactory - Class in org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time

A factory class for the construction of GeoQueryElement objects

TimeQueryElementFactory(QueryElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.queryelements.extensions.time.TimeQueryElementFactory

Creates a new instance of the factory

TimeURLElement - Class in org.gcube.opensearch.opensearchlibrary.urlelements.extensions.time

TimeURLElement(Element, URLElement) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.time.TimeURLElement

TimeURLElementFactory - Class in org.gcube.opensearch.opensearchlibrary.urlelements.extensions.time

A factory class for the construction of GeoURLElement objects

TimeURLElementFactory(URLElementFactory) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.extensions.time.TimeURLElementFactory

Creates a new instance of the factory

toString() - Method in exception org.gcube.opensearch.opensearchlibrary.query.MalformedQueryException

Returns a short description of this exception.

toString() - Method in exception org.gcube.opensearch.opensearchlibrary.query.NonExistentParameterException

Returns a short description of this exception.

toString() - Method in class org.gcube.opensearch.opensearchlibrary.utils.FactoryClassNamePair

totalResults - Variable in class org.gcube.opensearch.opensearchlibrary.responseelements.OpenSearchResponse

U

uidQname - Static variable in class org.gcube.opensearch.opensearchlibrary.GeoConstants

The qualified name for the uid parameter of Geo OpenSearch extensions

URLElement - Interface in org.gcube.opensearch.opensearchlibrary.urlelements

Interface of the URL Element class that is used to process URL elements contained in a DescriptionDocument

URLElementDecorator - Class in org.gcube.opensearch.opensearchlibrary.urlelements

URLElementDecorator(URLElement) - Constructor for class org.gcube.opensearch.opensearchlibrary.urlelements.URLElementDecorator

URLElementFactory - Interface in org.gcube.opensearch.opensearchlibrary.urlelements

Interface of the factory class used to construct URLElement objects

urlElementFactoryClass - Variable in class org.gcube.opensearch.opensearchlibrary.utils.FactoryClassNamePair

urlElFactory - Variable in class org.gcube.opensearch.opensearchlibrary.utils.FactoryPair

UrlEncode(String, String) - Static method in class org.gcube.opensearch.opensearchlibrary.utils.URLEncoder

URL-encodes a String only if it is not found already URL-encoded

URLEncoder - Class in org.gcube.opensearch.opensearchlibrary.utils

A URL encoder utility that is used to URL-encode strings only if they are not already URL-encoded

URLTemplate - Interface in org.gcube.opensearch.opensearchlibrary.query

Interface of the URL template class that is used to construct parse OpenSearch query templates and expose their parameters

useLocalResourceRepository - Variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

If false, OpenSearchResource retrieval is performed using an ISResourceRepository Otherwise, OpenSearchResources are retrieved locally (either from the local filesystem or from a url) using a LocalResourceRepository

useLocalResourceRepositoryDef - Static variable in class org.gcube.opensearch.opensearchoperator.OpenSearchOpConfig

The default value for OpenSearchOpConfig.useLocalResourceRepository

V

valueOf(String) - Static method in enum org.gcube.opensearch.opensearchlibrary.utils.SyndicationRight

Returns the enum constant of this type with the specified name.

values - Variable in class org.gcube.opensearch.opensearchlibrary.query.BasicQueryBuilder

values() - Static method in enum org.gcube.opensearch.opensearchlibrary.utils.SyndicationRight

Returns an array containing the constants of this enum type, in the order they are declared.

X

XMLResponse - Class in org.gcube.opensearch.opensearchlibrary.responseelements

Class implementing an OpenSearch XML response

XMLResponse(InputStream, QueryElementFactory, QueryBuilder, String, Map<String, String>) - Constructor for class org.gcube.opensearch.opensearchlibrary.responseelements.XMLResponse

XSLTs - Variable in class org.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResourceCache

Associates XSLT generic resource names with their XML representations

A B C D E F G H I L M N O P Q R S T U V X