Package de.uni_trier.wi2.procake.data.model.base

Interface CollectionClass

All Superinterfaces:

DataClass, PropertyHandler

All Known Subinterfaces:

ListClass, SetClass

All Known Implementing Classes:

CollectionClassImpl, ListClassImpl, SetClassImpl

public interface CollectionClass
extends DataClass

The Collection Classes SetClass and ListClass are both containers that can store each kind of data objects. Typical restrictions are the maximum and minimum number of elements and the base data class of whom the element objects must be instances. The difference between List and Set is that a List stores the elements in a fixed order, whereby a Set uses an arbitrary order.

Properties of collection classes:

Properties of collection classes

Data Class	Equal Element Types?	Elements Ordered?	Duplicates Possible?	Element Access	Number of Elements
SetClass	yes	no	no	iterator	variable
ListClass	yes	yes	yes	iterator	variable

Author:

rmaximi

See Also:

SetClass, ListClass

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLASS_NAME	The name of the class.
static String	COMPONENT	Component: "cake.data.model" (LogComponentIdentifier.COMPONENT)
static String	COMPONENT_KEY	Component-Key: "05" (LogComponentIdentifier.COMPONENT_KEY_COLLECTIONCLASS)
static String	LOG_INCONSISTENT_ELEMENTCLASS	Inconsistency between this class' element-class and the super-class' element class.
static String	LOG_MISSING_ELEMENTCLASS	No element class specified for this class.

Fields inherited from interface de.uni_trier.wi2.procake.data.model.DataClass

LOG_ABSTRACT_CLASS_NOT_INSTANTIABLE, LOG_ABSTRACT_SYSTEM_SUBCLASS_CREATION_FAILED, LOG_CLASS_NOT_EDITABLE, LOG_CLASS_NOT_INSTANTIABLE, LOG_EDITABLE_CLASS_NOT_INSTANTIABLE, LOG_FINISH_EDIT_FAILED, LOG_GET_SUPERCLASSES_FAILED, LOG_SUBCLASS_CREATION_FAILED

Method Summary

Modifier and Type	Method	Description
DataClass	getElementClass()	Each collection can contain elements of one special type.
int	getMaxCardinality()	getMaxCardinality.
int	getMinCardinality()	getMinCardinality.
void	setElementClass(DataClass elementClass)	Each collection can contain elements of one special type.
void	setMaxCardinality(int maxCardinality)	setMaxCardinality.
void	setMinCardinality(int minCardinality)	setMinCardinality.

Methods inherited from interface de.uni_trier.wi2.procake.data.model.DataClass

addSubclass, checkInstantiability, createSubclass, finishEditing, getModel, getName, getObjectClass, getSubClasses, getSuperClass, getSuperClasses, getSystemClassName, getSystemSuperClass, includeClass, isAbstract, isAggregate, isAtomic, isBoolean, isByteArray, isCake2DataReference, isChronologic, isCollection, isControlflowItem, isDataflowWrapper, isDate, isDouble, isEditable, isInstantiable, isInteger, isInterval, isList, isNESTConstraintEdge, isNESTControlflowEdge, isNESTControlflowNode, isNESTDataflowEdge, isNESTDataNode, isNESTEdge, isNESTGraph, isNESTGraphItem, isNESTNode, isNESTPartOfEdge, isNESTSequenceNode, isNESTSequentialWorkflow, isNESTSubWorkflowNode, isNESTTaskNode, isNESTWorkflow, isNESTWorkflowNode, isNode, isNumeric, isParentItem, isSequence, isSet, isString, isSubclassOf, isSubWorkflow, isSystemClass, isTask, isTime, isTimestamp, isUnion, isURI, isVoid, isWorkflow, isWorkflowItem, newObject, removeSubclass, setAbstract, setName

Methods inherited from interface de.uni_trier.wi2.procake.data.PropertyHandler

addProperty, addProperty, getAllProperties, getAllPropertyNodes, getProperty, getPropertyNames, getPropertyNode, getPropertyRootNode, hasProperties, removeProperty

Field Detail

CLASS_NAME

static final String CLASS_NAME

The name of the class. This name should be used in Model.getClass(String) to receive the system class. The value is * "Collection" .

See Also:

Constant Field Values

COMPONENT

static final String COMPONENT

Component: "cake.data.model" (LogComponentIdentifier.COMPONENT)

See Also:

Constant Field Values

COMPONENT_KEY

static final String COMPONENT_KEY

Component-Key: "05" (LogComponentIdentifier.COMPONENT_KEY_COLLECTIONCLASS)

See Also:

Constant Field Values

LOG_INCONSISTENT_ELEMENTCLASS

static final String LOG_INCONSISTENT_ELEMENTCLASS

Inconsistency between this class' element-class and the super-class' element class.

0. Component: COMPONENT
1. Key: "0501"
2. this
3. Element class
4. Super-Class element class
5. Super-Class

See Also:

Constant Field Values

LOG_MISSING_ELEMENTCLASS

static final String LOG_MISSING_ELEMENTCLASS

No element class specified for this class.

0. Component: COMPONENT
1. Key: "0500"
2. this

See Also:

Constant Field Values

Method Detail

getElementClass

DataClass getElementClass()

Each collection can contain elements of one special type. This type can be received with this method.

If several DataClasses should be used as type, you must summarize these classes in an UnionClass.

Returns:

The DataClass of the elements.

setElementClass

void setElementClass(DataClass elementClass)
              throws IllegalEditException

Each collection can contain elements of one special type. This type can be received with this method.

If several DataClasses should be used as type, you must summarize these classes in an UnionClass.

Parameters:

elementClass - The DataClass of the collection elements.

Throws:

IllegalEditException - if any.

getMaxCardinality

int getMaxCardinality()

getMaxCardinality.

Returns:

the maximum number of elements that are allowed in the CollectionObject

setMaxCardinality

void setMaxCardinality(int maxCardinality)
                throws IllegalEditException

setMaxCardinality.

Parameters:

maxCardinality - The maximum number of elements that are allowed in the CollectionObject.

Throws:

IllegalEditException - is thrown if the class is not editable, e.g., the class is already declared as finished.

getMinCardinality

int getMinCardinality()

getMinCardinality.

Returns:

the minimum number of elements that are required in the CollectionObject

setMinCardinality

void setMinCardinality(int minCardinality)
                throws IllegalEditException

setMinCardinality.

Parameters:

minCardinality - The minimum number of elements that are required in the CollectionObject.

Throws:

IllegalEditException - is thrown if the class is not editable, e.g., the class is already declared as finished.