|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OpenSearchResource
Interface of the OpenSearch resource class that contains information pertaining to an OpenSearch provider
Method Summary | |
---|---|
org.w3c.dom.Document |
getDescriptionDocument()
Retrieves the description document of the OpenSearch provider described by this resource |
java.lang.String |
getDescriptionDocURL()
Retrieves the URL of the description document of the OpenSearch provider described by this resource |
java.lang.String |
getName()
Returns the name of the OpenSearch provider |
java.lang.String |
getParameterQName(java.lang.String fieldName)
Retrieves the fully qualified name of an OpenSearch parameter which corresponds to a field |
java.util.Map<java.lang.String,java.lang.String> |
getParameters()
Retrieved the full mapping from field names to fully ns-qualified OpenSearch parameters as contained in the OpenSearch Resource |
java.util.Map<java.lang.String,java.lang.String> |
getPresentationInformation(java.lang.String MIMEType)
Retrieves the presentation information, that is, a mapping from field names to XPath expressions |
javax.xml.xpath.XPathExpression |
getRecordIdXPath(java.lang.String MIMEType)
Retrieves an XPathExpression that can be used to extract a record id a from a search result record |
javax.xml.xpath.XPathExpression |
getRecordSplitXPath(java.lang.String MIMEType)
Retrieves an XPathExpression that can be used to split a search result page of a given MIME type to individual records |
java.lang.String |
getSecuritySpecs()
Retrieves the security specifications of this OpenSearch provider |
java.util.List<java.lang.String> |
getTransformationTypes()
Retrieves a list of all MIME types for which there exists a transformation specification |
javax.xml.transform.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 |
javax.xml.transform.Transformer |
getTransformer(java.lang.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 |
---|
java.lang.String getName()
boolean isBrokered()
boolean isSecure()
java.lang.String getSecuritySpecs()
org.w3c.dom.Document getDescriptionDocument()
java.lang.String getDescriptionDocURL()
javax.xml.transform.Transformer getTransformer(java.lang.String MIMEType) throws java.lang.Exception
MIMEType
- The MIME type of the results that will be transformed
java.lang.Exception
- In case of errorjavax.xml.xpath.XPathExpression getRecordSplitXPath(java.lang.String MIMEType) throws java.lang.Exception
MIMEType
- The MIME type of the results returned by the provider described by this resource
java.lang.Exception
- In case of errorjavax.xml.xpath.XPathExpression getRecordIdXPath(java.lang.String MIMEType) throws java.lang.Exception
MIMEType
- The MIME type of the results returned by the provider described by this resource
java.lang.Exception
- In case of errorjavax.xml.transform.Transformer getTransformer() throws java.lang.Exception
java.lang.Exception
- In case of errorjava.util.List<java.lang.String> getTransformationTypes()
java.util.Map<java.lang.String,java.lang.String> getPresentationInformation(java.lang.String MIMEType)
java.lang.String getParameterQName(java.lang.String fieldName)
fieldName
- The name of the field corresponding to the requested OpenSearch parameter
java.util.Map<java.lang.String,java.lang.String> getParameters()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |