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

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

All Implemented Interfaces:

Cloneable, Evaluable

public class ForwardIndexDataType
extends DataType<ForwardIndexManagementWSResource>

Author:

Spyros Boutsis, NKUA

Field Summary

static String	ATTR_COLLECTIONID
static String	ATTR_COLLECTIONNAME
static String	ATTR_INDEXID
static String	ATTR_KEYNAMES
static String	ATTR_KEYTYPES

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

typeName, xml

Constructor Summary

ForwardIndexDataType(org.gcube.common.core.scope.GCUBEScope scope, ForwardIndexManagementWSResource associatedResource)

Method Summary

Object	clone()
void	copyDataFromResource() Updates all the attributes of this data types with the values of the corresponding attributes defined in the associated resource.
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()
String	getCollectionName()
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	getIndexedKeyNames()
String	getIndexedKeyTypes()
String	getIndexID()
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)
void	setCollectionName(String s)
void	setIndexedKeyNames(String s)
void	setIndexedKeyTypes(String s)
void	setIndexID(String s)

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

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

ATTR_COLLECTIONNAME

public static final String ATTR_COLLECTIONNAME

See Also:

Constant Field Values

ATTR_INDEXID

public static final String ATTR_INDEXID

See Also:

Constant Field Values

ATTR_KEYNAMES

public static final String ATTR_KEYNAMES

See Also:

Constant Field Values

ATTR_KEYTYPES

public static final String ATTR_KEYTYPES

See Also:

Constant Field Values

Constructor Detail

ForwardIndexDataType

public ForwardIndexDataType(org.gcube.common.core.scope.GCUBEScope scope,
                            ForwardIndexManagementWSResource 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<ForwardIndexManagementWSResource>

Returns:

copyDataFromResource

public void copyDataFromResource()
                          throws Exception

Description copied from class: DataType

Updates all the attributes of this data types with the values of the corresponding attributes defined in the associated resource.

Overrides:

copyDataFromResource in class DataType<ForwardIndexManagementWSResource>

Throws:

Exception

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<ForwardIndexManagementWSResource>

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<ForwardIndexManagementWSResource>

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<ForwardIndexManagementWSResource>

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<ForwardIndexManagementWSResource>

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<ForwardIndexManagementWSResource>

Returns:

the XML type definition document

Throws:

Exception

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class DataType<ForwardIndexManagementWSResource>

Throws:

CloneNotSupportedException

getIndexID

public String getIndexID()

setIndexID

public void setIndexID(String s)
                throws Exception

Throws:

Exception

getCollectionID

public String getCollectionID()

setCollectionID

public void setCollectionID(String s)
                     throws Exception

Throws:

Exception

getCollectionName

public String getCollectionName()

setCollectionName

public void setCollectionName(String s)
                       throws Exception

Throws:

Exception

getIndexedKeyNames

public String getIndexedKeyNames()

setIndexedKeyNames

public void setIndexedKeyNames(String s)
                        throws Exception

Throws:

Exception

getIndexedKeyTypes

public String getIndexedKeyTypes()

setIndexedKeyTypes

public void setIndexedKeyTypes(String s)
                        throws Exception

Throws:

Exception