OpenSearchResource (opensearchlibrary 1.6.1-SNAPSHOT API)

All Known Implementing Classes:

ISOpenSearchResource, LocalOpenSearchResource
```
public interface OpenSearchResource
```
Interface of the OpenSearch resource class that contains information pertaining to an OpenSearch provider

Author:

gerasimos.farantatos

Method Summary

Methods
Modifier and Type	Method and Description
`Document`	`getDescriptionDocument()` Retrieves the description document of the OpenSearch provider described by this resource
`String`	`getDescriptionDocURL()` Retrieves the URL of the description document of the OpenSearch provider described by this resource
`String`	`getName()` Returns the name of the OpenSearch provider
`String`	`getParameterQName(String fieldName)` Retrieves the fully qualified name of an OpenSearch parameter which corresponds to a field
`Map<String,String>`	`getParameters()` Retrieved the full mapping from field names to fully ns-qualified OpenSearch parameters as contained in the OpenSearch Resource
`Map<String,String>`	`getPresentationInformation(String MIMEType)` Retrieves the presentation information, that is, a mapping from field names to XPath expressions
`XPathExpression`	`getRecordIdXPath(String MIMEType)` Retrieves an XPathExpression that can be used to extract a record id a from a search result record
`XPathExpression`	`getRecordSplitXPath(String MIMEType)` Retrieves an XPathExpression that can be used to split a search result page of a given MIME type to individual records
`String`	`getSecuritySpecs()` Retrieves the security specifications of this OpenSearch provider
`List<String>`	`getTransformationTypes()` Retrieves a list of all MIME types for which there exists a transformation specification
`Transformer`	`getTransformer()` 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
`Transformer`	`getTransformer(String MIMEType)` 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
`boolean`	`isBrokered()` Determines whether the provider described by this resource returns brokered results, i.e the results it returns describe other OpenSearch providers
`boolean`	`isSecure()` Determines if the provider described by this resource uses a security scheme

- Method Detail
  - getName
```
String getName()
```
    Returns the name of the OpenSearch provider
    
    Returns:
    The name of the OpenSearch provider
  - isBrokered
```
boolean isBrokered()
```
    Determines whether the provider described by this resource returns brokered results, i.e the results it returns describe other OpenSearch providers
    
    Returns:
    true if the provider returns brokered results, false otherwise
  - isSecure
```
boolean isSecure()
```
    Determines if the provider described by this resource uses a security scheme
    
    Returns:
    true if the provider uses a security scheme, false otherwise
  - getSecuritySpecs
```
String getSecuritySpecs()
```
    Retrieves the security specifications of this OpenSearch provider
    
    Returns:
    The security specifications of the provider
  - getDescriptionDocument
```
Document getDescriptionDocument()
```
    Retrieves the description document of the OpenSearch provider described by this resource
    
    Returns:
    A Document representing the description document of the provider
  - getDescriptionDocURL
```
String getDescriptionDocURL()
```
    Retrieves the URL of the description document of the OpenSearch provider described by this resource
    
    Returns:
    A String containing the URL of the description document of the provider
  - getTransformer
```
Transformer getTransformer(String MIMEType)
                           throws Exception
```
    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
    
    Parameters:
    MIMEType - The MIME type of the results that will be transformed
    
    Returns:
    The transformer that can be used to transform the results of the given MIME type
    
    Throws:
    
    Exception - In case of error
  - getRecordSplitXPath
```
XPathExpression getRecordSplitXPath(String MIMEType)
                                    throws Exception
```
    Retrieves an XPathExpression that can be used to split a search result page of a given MIME type to individual records
    
    Parameters:
    MIMEType - The MIME type of the results returned by the provider described by this resource
    
    Returns:
    The Xpath expression that can be used to split search result pages to individual records
    
    Throws:
    
    Exception - In case of error
  - getRecordIdXPath
```
XPathExpression getRecordIdXPath(String MIMEType)
                                 throws Exception
```
    Retrieves an XPathExpression that can be used to extract a record id a from a search result record
    
    Parameters:
    MIMEType - The MIME type of the results returned by the provider described by this resource
    
    Returns:
    The Xpath expression that can be used extract a record id from a search result record
    
    Throws:
    
    Exception - In case of error
  - getTransformer
```
Transformer getTransformer()
                           throws Exception
```
    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
    
    Returns:
    The transformer that can be used to transform the results of the first MIME type appearing in this OpenSearch resource
    
    Throws:
    
    Exception - In case of error
  - getTransformationTypes
```
List<String> getTransformationTypes()
```
    Retrieves a list of all MIME types for which there exists a transformation specification
    
    Returns:
    All MIME types for which there exists a transformation specification
  - getPresentationInformation
```
Map<String,String> getPresentationInformation(String MIMEType)
```
    Retrieves the presentation information, that is, a mapping from field names to XPath expressions
    
    Returns:
  - getParameterQName
```
String getParameterQName(String fieldName)
```
    Retrieves the fully qualified name of an OpenSearch parameter which corresponds to a field
    
    Parameters:
    fieldName - The name of the field corresponding to the requested OpenSearch parameter
    
    Returns:
    The fully qualified name of the OpenSearch parameter
  - getParameters
```
Map<String,String> getParameters()
```
    Retrieved the full mapping from field names to fully ns-qualified OpenSearch parameters as contained in the OpenSearch Resource
    
    Returns:
    All field name to fully ns-qualified mappings

Interface OpenSearchResource

Method Summary

Method Detail

getName

isBrokered

isSecure

getSecuritySpecs

getDescriptionDocument

getDescriptionDocURL

getTransformer

getRecordSplitXPath

getRecordIdXPath

getTransformer

getTransformationTypes

getPresentationInformation

getParameterQName

getParameters