|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.opensearch.opensearchoperator.resource.LocalOpenSearchResource
public class LocalOpenSearchResource
Class implementing the OpenSearchResource interface that processes OpenSearch resources in the absence of an InformationSystem
Constructor Summary | |
---|---|
LocalOpenSearchResource(java.io.File file,
java.io.File schemaFile)
Creates a new LocalOpenSearchResource whose XML representation is stored in a file |
|
LocalOpenSearchResource(java.lang.String xml,
java.io.File schemaFile)
Creates a new LocalOpenSearchResouce whose XML representation is stored in a String |
|
LocalOpenSearchResource(java.lang.String name,
java.net.URL DDUrl,
boolean brokered)
Creates a new LocalOpenSearchResource by directly providing its attributes |
|
LocalOpenSearchResource(java.net.URL url,
java.io.File schemaFile)
Creates a new LocalOpenSearchResource whose XML representation can be retrieved through a URL |
Method Summary | |
---|---|
void |
addTransformation(java.lang.String MIMEType,
java.lang.String recordSplitXPath,
java.lang.String recordIdXPath,
java.net.URL XSLTUrl,
java.util.Map<java.lang.String,java.lang.String> presentationInfo)
Adds a transformation specification to the OpenSearch resource |
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 |
static void |
main(java.lang.String[] args)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LocalOpenSearchResource(java.lang.String name, java.net.URL DDUrl, boolean brokered) throws java.io.IOException, javax.xml.parsers.ParserConfigurationException, org.xml.sax.SAXException
name
- The name of the OpenSearch resource to be createdDDUrl
- The URL of the description document of the OpenSearch provider that will be associated with the OpenSearch resource to be createdbrokered
- true if the OpenSearch resource to be created provides brokered results, false otherwise
java.io.IOException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
public LocalOpenSearchResource(java.io.File file, java.io.File schemaFile) throws java.lang.Exception
file
- The file where the XML representation of the OpenSearch resource is storedschemaFile
- The schema file describing the schema of the OpenSearch resource to be used for validation. This is an optional parameter.
If null, no validation will be performed
java.lang.Exception
- If the resource is malformed or in case of other errorpublic LocalOpenSearchResource(java.lang.String xml, java.io.File schemaFile) throws java.lang.Exception
xml
- The XML representation of the OpenSearch resource to be createdschemaFile
- The schema file describing the schema of the OpenSearch resource to be used for validation. This is an optional parameter.
If null, no validation will be performed
java.lang.Exception
- If the resource is malformed or in case of other errorpublic LocalOpenSearchResource(java.net.URL url, java.io.File schemaFile) throws java.lang.Exception
url
- The URL that will be used to retrieve the XML representation of the OpenSearch resource
to be createdschemaFile
- The schema file describing the schema of the OpenSearch resource to be used for validation. This is an optional parameter.
If null, no validation will be performed
java.lang.Exception
- If the resource is malformed or in case of other errorMethod Detail |
---|
public void addTransformation(java.lang.String MIMEType, java.lang.String recordSplitXPath, java.lang.String recordIdXPath, java.net.URL XSLTUrl, java.util.Map<java.lang.String,java.lang.String> presentationInfo) throws java.lang.Exception
MIMEType
- The MIME type of the results that will be associated with the transformation specificationsrecordSplitXPath
- The Xpath expression to be used to split the results contained in a search result page to individual recordsrecordIdXPath
- The Xpath expression to be used to extract a record id from a record of the search resultsXSLTUrl
- The URL of the XSLT to be used to transform the search result records to the desired formpresentationInfo
- A mapping from presentable field names to XPath expressions that will be used to extract result fields from
the results returned by the provider
java.lang.Exception
- In case of errorpublic java.lang.String getName()
getName
in interface OpenSearchResource
OpenSearchResource.getName()
public boolean isBrokered()
isBrokered
in interface OpenSearchResource
OpenSearchResource.isBrokered()
public boolean isSecure()
isSecure
in interface OpenSearchResource
OpenSearchResource.isSecure()
public java.lang.String getSecuritySpecs()
getSecuritySpecs
in interface OpenSearchResource
OpenSearchResource.getSecuritySpecs()
public org.w3c.dom.Document getDescriptionDocument()
getDescriptionDocument
in interface OpenSearchResource
OpenSearchResource.getDescriptionDocument()
public java.lang.String getDescriptionDocURL()
getDescriptionDocURL
in interface OpenSearchResource
OpenSearchResource.getDescriptionDocURL()
public javax.xml.transform.Transformer getTransformer(java.lang.String MIMEType) throws java.lang.Exception
getTransformer
in interface OpenSearchResource
MIMEType
- The MIME type of the results that will be transformed
java.lang.Exception
- In case of errorOpenSearchResource.getTransformer(String)
public javax.xml.xpath.XPathExpression getRecordSplitXPath(java.lang.String MIMEType) throws java.lang.Exception
getRecordSplitXPath
in interface OpenSearchResource
MIMEType
- The MIME type of the results returned by the provider described by this resource
java.lang.Exception
- In case of errorOpenSearchResource.getRecordSplitXPath(String)
public javax.xml.xpath.XPathExpression getRecordIdXPath(java.lang.String MIMEType) throws java.lang.Exception
getRecordIdXPath
in interface OpenSearchResource
MIMEType
- The MIME type of the results returned by the provider described by this resource
java.lang.Exception
- In case of errorOpenSearchResource.getRecordIdXPath(String)
public javax.xml.transform.Transformer getTransformer() throws java.lang.Exception
getTransformer
in interface OpenSearchResource
java.lang.Exception
- In case of errororg.gcube.opensearch.opensearchoperator.resource.OpenSearchResource#getTransformer())
public java.util.Map<java.lang.String,java.lang.String> getPresentationInformation(java.lang.String MIMEType)
getPresentationInformation
in interface OpenSearchResource
OpenSearchResource.getPresentationInformation(String)
public java.util.List<java.lang.String> getTransformationTypes()
getTransformationTypes
in interface OpenSearchResource
OpenSearchResource.getTransformationTypes()
public java.lang.String getParameterQName(java.lang.String fieldName)
OpenSearchResource
getParameterQName
in interface OpenSearchResource
fieldName
- The name of the field corresponding to the requested OpenSearch parameter
public java.util.Map<java.lang.String,java.lang.String> getParameters()
OpenSearchResource
getParameters
in interface OpenSearchResource
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |