public interface OpenSearchResource
| 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
|
String getName()
boolean isBrokered()
boolean isSecure()
String getSecuritySpecs()
Document getDescriptionDocument()
String getDescriptionDocURL()
Transformer getTransformer(String MIMEType) throws Exception
MIMEType - The MIME type of the results that will be transformedException - In case of errorXPathExpression getRecordSplitXPath(String MIMEType) throws Exception
MIMEType - The MIME type of the results returned by the provider described by this resourceException - In case of errorXPathExpression getRecordIdXPath(String MIMEType) throws Exception
MIMEType - The MIME type of the results returned by the provider described by this resourceException - In case of errorTransformer getTransformer() throws Exception
Exception - In case of errorList<String> getTransformationTypes()
Map<String,String> getPresentationInformation(String MIMEType)
String getParameterQName(String fieldName)
fieldName - The name of the field corresponding to the requested OpenSearch parameterCopyright © 2014. All Rights Reserved.