org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.data
Class OpenSearchDataType

java.lang.Object
  org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.data.DataType<OpenSearchWSResource>
      org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.data.OpenSearchDataType

All Implemented Interfaces:

Cloneable, Evaluable

public class OpenSearchDataType
extends DataType<OpenSearchWSResource>

Field Summary

static String

ATTR_COLLECTIONID

Fields inherited from class org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.data.DataType

typeName, xml

Constructor Summary

OpenSearchDataType(org.gcube.common.core.scope.GCUBEScope scope, OpenSearchWSResource associatedResource)

Method Summary

Object	clone()
boolean	doesIdentifyUniqueResource() Returns true if the currently defined attributes of this DataType are adequate in order to uniquely identify a resource in the infrastructure.
String	getCollectionID()
Map<String,String>	getDataTypeAttrToResourceAttrMappings() Returns (dataTypeAttrValue, resourceAttrValue) pairs, which describe the mappings between attributes defined in this data types and attributes defined in the wrapped type of resource.
String	getUID() Returns an identifier that uniquely identifies the specific DataType instance.
String	getUIDescription() Returns a string which will be displayed as the description of this DataType in the UI.
String	getUIName() Returns a string which will be displayed as the name of this DataType in the UI.
Document	getXMLTypeDefinitionDocument() Returns a Document object defining the XML structure of this DataType's contents.
void	setCollectionID(String s)

Methods inherited from class org.gcube.portlets.admin.irbootstrapperportlet.gwt.server.types.data.DataType

copyDataFromResource, copyDataToResource, evaluate, findMatchesInScope, getAssociatedResource, getAttributeValue, getScope, getTypeDefinition, getTypeName, initialize, setAttributeValue

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATTR_COLLECTIONID

public static final String ATTR_COLLECTIONID

See Also:

Constant Field Values

Constructor Detail

OpenSearchDataType

public OpenSearchDataType(org.gcube.common.core.scope.GCUBEScope scope,
                          OpenSearchWSResource associatedResource)

Method Detail

getDataTypeAttrToResourceAttrMappings

public Map<String,String> getDataTypeAttrToResourceAttrMappings()

Description copied from class: DataType

Returns (dataTypeAttrValue, resourceAttrValue) pairs, which describe the mappings between attributes defined in this data types and attributes defined in the wrapped type of resource.

Specified by:

getDataTypeAttrToResourceAttrMappings in class DataType<OpenSearchWSResource>

Returns:

doesIdentifyUniqueResource

public boolean doesIdentifyUniqueResource()

Description copied from class: DataType

Returns true if the currently defined attributes of this DataType are adequate in order to uniquely identify a resource in the infrastructure. If the DataType attributes could possibly describe more than one resources, this method should return false;

Specified by:

doesIdentifyUniqueResource in class DataType<OpenSearchWSResource>

Returns:

getUID

public String getUID()

Description copied from class: DataType

Returns an identifier that uniquely identifies the specific DataType instance. It is guaranteed that when this method is called, the DataType will be fully defined, meaning that none of its attributes will be empty. This guarantee is given so that subclasses implementing this method can freely depend on any attribute required in order to construct the unique ID.

Specified by:

getUID in class DataType<OpenSearchWSResource>

Returns:

the DataType's UID

getUIDescription

public String getUIDescription()
                        throws Exception

Description copied from class: DataType

Returns a string which will be displayed as the description of this DataType in the UI.

Specified by:

getUIDescription in class DataType<OpenSearchWSResource>

Returns:

the DataType's description

Throws:

Exception

getUIName

public String getUIName()
                 throws Exception

Description copied from class: DataType

Returns a string which will be displayed as the name of this DataType in the UI.

Specified by:

getUIName in class DataType<OpenSearchWSResource>

Returns:

the DataType's name

Throws:

Exception

getXMLTypeDefinitionDocument

public Document getXMLTypeDefinitionDocument()
                                      throws Exception

Description copied from class: DataType

Returns a Document object defining the XML structure of this DataType's contents.

Specified by:

getXMLTypeDefinitionDocument in class DataType<OpenSearchWSResource>

Returns:

the XML type definition document

Throws:

Exception

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class DataType<OpenSearchWSResource>

Throws:

CloneNotSupportedException

getCollectionID

public String getCollectionID()

setCollectionID

public void setCollectionID(String s)
                     throws Exception

Throws:

Exception