|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.opensearch.opensearchoperator.resource.ISOpenSearchResource
public class ISOpenSearchResource
Class implementing the OpenSearchResource interface that processes OpenSearch resources when an InformationSystem is available
Constructor Summary | |
---|---|
ISOpenSearchResource(java.lang.String xml,
gr.uoa.di.madgik.environment.hint.EnvHintCollection envHints)
Creates a new ISOpenSearchResource that will not use a cache |
|
ISOpenSearchResource(java.lang.String xml,
java.util.Map<java.lang.String,java.lang.String> cachedDescriptionDocs,
java.util.Map<java.lang.String,java.lang.String> cachedResourcesXML,
java.util.Map<java.lang.String,java.lang.String> cachedXSLTs,
gr.uoa.di.madgik.environment.hint.EnvHintCollection envHints)
Creates a new ISOpenSearchResource with a cache that will be used and further populated |
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 |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ISOpenSearchResource(java.lang.String xml, java.util.Map<java.lang.String,java.lang.String> cachedDescriptionDocs, java.util.Map<java.lang.String,java.lang.String> cachedResourcesXML, java.util.Map<java.lang.String,java.lang.String> cachedXSLTs, gr.uoa.di.madgik.environment.hint.EnvHintCollection envHints) throws java.lang.Exception
xml
- The XML representation of the OpenSearch resourcecachedDescriptionDocs
- A cache containing description documents in XML form, identified by their URLscachedResourcesXML
- A cache containing OpenSearch resources in XML form, identified by their description document URLscachedXSLTs
- A cache containing XSLTs in XML form, identified by the names of the generic resources associated with themenvHints
- The environment hints that to be passed to the InformationSystem
java.lang.Exception
- If the resource is malformed or in case of other errorpublic ISOpenSearchResource(java.lang.String xml, gr.uoa.di.madgik.environment.hint.EnvHintCollection envHints) throws java.lang.Exception
xml
- The XML representation of the OpenSearch resourceenvHints
- The environment hints that to be passed to the InformationSystem
java.lang.Exception
- If the resource is malformed or in case of other errorMethod Detail |
---|
public 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 errorOpenSearchResource.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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |