|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.ObjectGCUBEWSResource
org.gcube.opensearch.opensearchdatasource.OpenSearchDataSourceResource
public class OpenSearchDataSourceResource
A class containing stateful information regarding an OpenSearch adaptor.
| Field Summary | |
|---|---|
java.util.List<java.lang.String> |
allPresentableNames
|
ISOpenSearchResourceCache |
cache
|
ISOpenSearchResource[] |
openSearchGenericResources
|
java.util.List<java.lang.String> |
presentableFields
|
static java.lang.String |
RP_ADAPTOR_ID
The list of standard resource properties defined by every OpenSearch WS resource |
static java.lang.String |
RP_COLLECTION_ID
|
static java.lang.String |
RP_DESCRIPTION_DOCUMENT_URI
|
static java.lang.String |
RP_FIELDS
|
static java.lang.String |
RP_FIXEDPARAMETERS
|
static java.lang.String |
RP_OPENSEARCH_RESOURCE
|
static java.lang.String |
RP_SUPPORTED_RELATIONS
|
java.util.List<java.lang.String> |
searchableFields
|
| Constructor Summary | |
|---|---|
OpenSearchDataSourceResource()
Empty constructor. |
|
| Method Summary | |
|---|---|
void |
addCachedOpenSearchResource(java.lang.String ddURL,
XMLResult resource)
Adds an OpenSearch Resource to the brokered provider's resource cache |
void |
addCachedOpenSearchResources(java.util.Map<java.lang.String,XMLResult> resources)
Adds the OpenSearch Resources contained in the map to the brokered provider's resource cache |
void |
addCollectionID(java.lang.String collectionID)
Adds a collection id to the collectionID resource property |
void |
addDescriptionDocumentURI(java.lang.String descriptionDocumentURI)
|
void |
addProviders(java.lang.String[] fields,
java.lang.String[] collectionIds,
java.lang.String[] openSearchResourceIDs,
java.lang.String[][] fixedParams)
|
java.lang.String |
getAdaptorID()
Getter method for the AdaptorID Resource Property |
OpenSearchResource |
getCachedOpenSearchResource(java.lang.String ddURL)
Returns the cached OpenSearch Resource of a brokered provider whose description document URL is ddURL |
java.util.List<OpenSearchResource> |
getCachedOpenSearchResources()
Returns all cached OpenSearch Resources of the brokered providers associated with the provider of this WS-Resource |
java.lang.String[] |
getCollectionID()
Getter method for the CollectionID list Resource Property |
org.w3c.dom.Document |
getDescriptionDocument(int i)
Getter method for the cached Description document |
java.lang.String[] |
getDescriptionDocumentURI()
Getter method for the DescriptionDocumentURI list Resource Property |
java.lang.String |
getDescriptionDocumentURI(int i)
Getter method for the DescriptionDocument Resource Property |
java.lang.String[] |
getFields()
Getter method for the Fields list Resource Property |
java.lang.String[] |
getFixedParameters()
Getter method for the FixedParameters list Resource Property |
EnvHintCollection |
getISEnvHints()
Retrieves the InformationSystem environmental hints that this resource is using |
java.lang.String[] |
getOpenSearchResource()
Getter method for the OpenSearchResource list Resource Property |
java.lang.String |
getOpenSearchResource(int i)
Getter method for the OpenSearchResource Resource Property |
java.lang.String[] |
getPropertyNames()
Retrieves the property names |
boolean |
isInitializing()
Returns the current initialization state of the resource |
void |
onResourceRemoval()
|
java.net.URI |
query(java.lang.String cqlQuery)
Performs a query on the OpenSearch provider that is connected to this resource. |
static XMLResult |
retrieveGenericResource(java.lang.String id,
GCUBEScope scope)
Retrieves a generic resource using the IS |
static java.lang.String[] |
retrieveTemplates(DescriptionDocument dd,
OpenSearchResource res)
|
void |
setAdaptorID(java.lang.String adaptorID)
Setter method for the AdaptorID Resource Property |
void |
setCollectionID(java.lang.String[] collectionIDs)
Setter method for the CollectionID list Resource Property |
void |
setDescriptionDocumentURI(java.lang.String descriptionDocumentURI)
Setter method for the DescriptionDocument Resource Property |
void |
setDescriptionDocumentURI(java.lang.String[] descriptionDocumentURIs)
Setter method for the DescriptionDocumentURI list Resource Property |
void |
setFixedParameters(java.lang.String[] fixedParameters)
Setter method for the FixedParameters list Resource Property |
void |
setIsInitializing(boolean isInitializing)
Specifies the current state of the resource (initializing or not) |
void |
setOpenSearchResource(java.lang.String openSearchResource)
Setter method for the OpenSearchResource Resource Property |
void |
setOpenSearchResource(java.lang.String[] openSearchResource)
Setter method for the OpenSearchResource list Resource Property |
void |
store()
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public ISOpenSearchResource[] openSearchGenericResources
public ISOpenSearchResourceCache cache
public java.util.List<java.lang.String> searchableFields
public java.util.List<java.lang.String> presentableFields
public java.util.List<java.lang.String> allPresentableNames
public static final java.lang.String RP_ADAPTOR_ID
public static final java.lang.String RP_COLLECTION_ID
public static final java.lang.String RP_SUPPORTED_RELATIONS
public static final java.lang.String RP_FIELDS
public static final java.lang.String RP_DESCRIPTION_DOCUMENT_URI
public static final java.lang.String RP_FIXEDPARAMETERS
public static final java.lang.String RP_OPENSEARCH_RESOURCE
| Constructor Detail |
|---|
public OpenSearchDataSourceResource()
| Method Detail |
|---|
public static java.lang.String[] retrieveTemplates(DescriptionDocument dd,
OpenSearchResource res)
throws java.lang.Exception
java.lang.Exceptionpublic java.lang.String[] getPropertyNames()
public boolean isInitializing()
public void setIsInitializing(boolean isInitializing)
isInitializing - the initialization state to set
public void addProviders(java.lang.String[] fields,
java.lang.String[] collectionIds,
java.lang.String[] openSearchResourceIDs,
java.lang.String[][] fixedParams)
throws java.lang.Exception
java.lang.Exception
public static XMLResult retrieveGenericResource(java.lang.String id,
GCUBEScope scope)
throws java.lang.Exception
id - The id of the generic resource to retrievescope - The scope to use
java.lang.Exception - In case of errorpublic void store()
public java.lang.String getAdaptorID()
String the requested adaptorIDpublic void setAdaptorID(java.lang.String adaptorID)
adaptorID - String the new AdaptorIDpublic java.lang.String[] getFields()
String[] the requested Fieldspublic java.lang.String[] getCollectionID()
String[] the requested CollectionIDs
public void setCollectionID(java.lang.String[] collectionIDs)
throws java.lang.Exception
collectionIDs - String[] the new CollectionIDs
java.lang.Exceptionpublic void addCollectionID(java.lang.String collectionID)
collectionID - String -the ID to be addedpublic java.lang.String[] getDescriptionDocumentURI()
String[] the requested DescriptionDocumentURIspublic java.lang.String getDescriptionDocumentURI(int i)
String the requested DescriptionDocumentURI
public void setDescriptionDocumentURI(java.lang.String descriptionDocumentURI)
throws java.lang.Exception
descriptionDocumentURI - String the new DescriptionDocumentURI
java.lang.Exception - In case of error
public void addDescriptionDocumentURI(java.lang.String descriptionDocumentURI)
throws java.lang.Exception
java.lang.Exception
public void setDescriptionDocumentURI(java.lang.String[] descriptionDocumentURIs)
throws java.lang.Exception
descriptionDocumentURIs - String[] the new DescriptionDocumentURIs
java.lang.Exception - In case of errorpublic java.lang.String[] getFixedParameters()
String[] the requested FixedParameters
public void setFixedParameters(java.lang.String[] fixedParameters)
throws java.lang.Exception
fixedParameters - String[] the new FixedParameters
java.lang.Exception - In case of errorpublic java.lang.String getOpenSearchResource(int i)
String the OpenSearchResource IDpublic java.lang.String[] getOpenSearchResource()
String the OpenSearchResource IDpublic void setOpenSearchResource(java.lang.String openSearchResource)
openSearchResource - String the new OpenSearchResource IDpublic void setOpenSearchResource(java.lang.String[] openSearchResource)
openSearchResource - String the new OpenSearchResource IDpublic org.w3c.dom.Document getDescriptionDocument(int i)
public OpenSearchResource getCachedOpenSearchResource(java.lang.String ddURL)
ddURL - the URL of the brokered provider's description document
public java.util.List<OpenSearchResource> getCachedOpenSearchResources()
public void addCachedOpenSearchResource(java.lang.String ddURL,
XMLResult resource)
throws java.lang.Exception
ddURL - the URL of the brokered provider's description documentresource - the OpenSearch Resource for the brokered provider
java.lang.Exception - In case of error
public void addCachedOpenSearchResources(java.util.Map<java.lang.String,XMLResult> resources)
throws java.lang.Exception
resources - A map containing a mappings from description document URLs to OpenSearch Resources for
each brokered provider
java.lang.Exception - In case of error
public java.net.URI query(java.lang.String cqlQuery)
throws java.rmi.RemoteException
queryString - String - the query to be performed (using custom
syntax @see )
URI - representation of the EPR for a resultset service which holds the results of the query.
java.rmi.RemoteException - In case of errorpublic EnvHintCollection getISEnvHints()
InformationSystem environmental hints that this resource is using
public void onResourceRemoval()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||