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

Class AtomicClassImpl

java.lang.Object

de.uni_trier.wi2.procake.data.model.impl.AbstractDataClassImpl

de.uni_trier.wi2.procake.data.model.base.impl.AtomicClassImpl

All Implemented Interfaces:

AtomicClass, DataClass, PropertyHandler

Direct Known Subclasses:

BooleanClassImpl, ByteArrayClassImpl, ChronologicClassImpl, NumericClassImpl, StringClassImpl, URIClassImpl

public class AtomicClassImpl
extends AbstractDataClassImpl
implements AtomicClass

Description is missing

Author:

Rainer Maximini

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	defaultValue

Fields inherited from interface de.uni_trier.wi2.procake.data.model.base.AtomicClass

CLASS_NAME, COMPONENT, COMPONENT_KEY, LOG_CANNOT_HANDLE_NATIVE_VALUES, LOG_INTERVAL_BORDERS_INCOMPATIBLE, LOG_PARSING_NATIVE_VALUE, LOG_UNKNOWN_NATIVE_VALUE, LOG_UNKNOWN_VALUE_IN_ORDER, LOG_VALUE_RANGE_INCOMPATIBLE

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

CLASS_NAME, COMPONENT, COMPONENT_KEY, 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

Constructor Summary

Constructors

Modifier	Constructor	Description
	AtomicClassImpl()	Constructor for AtomicClassImpl.
protected	AtomicClassImpl(String name)	Constructor for AtomicClassImpl.

Method Summary

Modifier and Type	Method	Description
void	addAtomicObject(AtomicObject atomicObject)	addAtomicObject.
protected void	checkFinishEditing()	This method only checks if it is possible to finish the class and does not change any internal status.
InstanceEnumerationPredicate	createNewInstanceEnumerationPredicate()	Creates a new InstanceEnumerationPredicatefor this class.
InstanceIntervalPredicate	createNewInstanceIntervalPredicate()	Creates a new InstanceIntervalPredicatefor this class.
InstanceOntologyOrderPredicate	createNewInstanceOntologyOrderPredicate()	createNewInstanceOntologyOrderPredicate.
InstanceTaxonomyOrderPredicate	createNewInstanceTaxonomyOrderPredicate()	createNewInstanceTaxonomyOrderPredicate.
InstanceTotalOrderPredicate	createNewInstanceTotalOrderPredicate()	createNewInstanceTotalOrderPredicate.
protected void	createSystemSubClasses()	createSystemSubClasses.
void	finishEditing()	To instantiate classes it is necessary to know if the class can be edited further.
LinkedList<AtomicObject>	getAtomicObjects()	getAtomicObjects.
Object	getDefaultValue()	The default value is either a defined value with AtomicClass.setDefaultValue(Object) or an arbitrary but valid one.
InstanceEnumerationPredicate	getInstanceEnumerationPredicate()	getInstanceEnumerationPredicate.
InstanceIntervalPredicate	getInstanceIntervalPredicate()	getInstanceIntervalPredicate.
InstancePredicate	getInstancePredicate()	Returns the instance predicate that is defined in the atomic class
InstanceTaxonomyOrderPredicate	getInstanceTaxonomyOrderPredicate()	getInstanceTaxonomyOrderPredicate.
InstanceTotalOrderPredicate	getInstanceTotalOrderPredicate()	getInstanceTotalOrderPredicate.
protected Object	getInternalDefaultValue()	getInternalDefaultValue.
protected AtomicObject	getNativeValueFromPredicate()	getNativeValueFromPredicate.
boolean	hasEnumerationRange()	Checks if an InstancePredicate is defined and if the predicate is an InstanceEnumerationPredicate.
boolean	hasIntervalRange()	Checks if an InstancePredicate is defined and if the predicate is an InstanceIntervalPredicate.
boolean	hasTaxonomyRange()	hasTaxonomyRange.
boolean	hasTotalOrderRange()	hasTotalOrderRange.
boolean	isAtomic()	isAtomic.
Object	nativeFromString(String value)	Converts a String to the native object of the corresponding AtomicObject
String	nativeToString(Object value)	Converts a native object of the corresponding AtomicObject to a String.
InstancePredicate	removeInstancePredicate()	Removes a defined InstancePredicate from the atomic class.
void	setDefaultValue(Object defaultValue)	Each AtomicClass contains a default value that is used to initialize an AtomicObject.

Methods inherited from class de.uni_trier.wi2.procake.data.model.impl.AbstractDataClassImpl

addProperty, addProperty, addSubclass, addSubClass, beSystemClass, checkEditability, checkInstantiability, clearSubClasses, createSubclass, createSystemClassTree, getAllProperties, getAllPropertyNodes, getModel, getName, getObjectClass, getProperty, getPropertyNames, getPropertyNode, getPropertyRootNode, getRootClass, getSubClasses, getSuperClass, getSuperClasses, getSystemClassName, getSystemSuperClass, hasProperties, includeClass, isAbstract, isAdaptationCase, isAggregate, isBoolean, isByteArray, isCake2DataReference, isChronologic, isCollection, isControlflowItem, isDataflowWrapper, isDate, isDouble, isEditable, isInstantiable, isInteger, isInterval, isList, isNESTAdaptationQuery, isNESTAdaptationRule, isNESTAdaptationSession, isNESTAdaptationStep, isNESTConstraintEdge, isNESTControlflowEdge, isNESTControlflowNode, isNESTDataflowEdge, isNESTDataNode, isNESTEdge, isNESTGraph, isNESTGraphItem, isNESTNode, isNESTPartOfEdge, isNESTQuery, isNESTSequenceNode, isNESTSequentialWorkflow, isNESTSubWorkflowNode, isNESTTaskNode, isNESTWorkflow, isNESTWorkflowNode, isNode, isNumeric, isParentItem, isSequence, isSet, isString, isSubclassOf, isSubWorkflow, isSystemClass, isTask, isTime, isTimestamp, isUnion, isURI, isVoid, isWorkflow, isWorkflowCase, isWorkflowItem, newObject, removeProperty, removeSubclass, removeSubClass, setAbstract, setName, setSuperClass, toString

Methods inherited from class java.lang.Object

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

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

addSubclass, checkInstantiability, createSubclass, getModel, getName, getObjectClass, getSubClasses, getSuperClass, getSuperClasses, getSystemClassName, getSystemSuperClass, includeClass, isAbstract, isAggregate, 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

defaultValue

protected Object defaultValue

Constructor Detail

AtomicClassImpl

public AtomicClassImpl()

Constructor for AtomicClassImpl.

AtomicClassImpl

protected AtomicClassImpl(String name)

Constructor for AtomicClassImpl.

Parameters:

name - a String object

Method Detail

checkFinishEditing

protected void checkFinishEditing()
                           throws ClassHierarchyConsistencyException

This method only checks if it is possible to finish the class and does not change any internal status. To initialize internal caches use the method AbstractDataClassImpl.finishEditing().

Sub classes are allowed to overwrite this method with own code but they must follow some instructions. It is very important to call the AbstractDataClassImpl.checkFinishEditing() method in the super class. This can be done before or after the own check methods. But it is advisable to implement the methods like in AbstractDataClassImpl.finishEditing() where first the super class is called. For example:

protected void checkFinishEditing() throws ClassHierarchyConsistencyException { super.checkFinishEditing(); // put your code here }

Overrides:

checkFinishEditing in class AbstractDataClassImpl

Throws:

ClassHierarchyConsistencyException

See Also:

AbstractDataClassImpl.finishEditing()

createNewInstanceEnumerationPredicate

public InstanceEnumerationPredicate createNewInstanceEnumerationPredicate()
                                                                   throws IllegalEditException

Creates a new InstanceEnumerationPredicatefor this class. The predicate is automitcally assigned. If a predicate is already defined, it will be removed and replaced with the new one.

After creation the old instance predicate is no longer available. If it is needed call the getInstancePredicate() method first. *

Specified by:

createNewInstanceEnumerationPredicate in interface AtomicClass

Returns:

The new instance of InstanceEnumerationPredicate.

Throws:

IllegalEditException

createNewInstanceIntervalPredicate

public InstanceIntervalPredicate createNewInstanceIntervalPredicate()
                                                             throws IllegalEditException

Creates a new InstanceIntervalPredicatefor this class. The predicate is automatically assigned. If a predicate is already defined, it will be removed and replaced with the new one.

After creation the old instance predicate is no longer available. If it is needed call the getInstancePredicate() method first.

Specified by:

createNewInstanceIntervalPredicate in interface AtomicClass

Returns:

The new instance of InstanceIntervalPredicate.

Throws:

IllegalEditException

createNewInstanceTaxonomyOrderPredicate

public InstanceTaxonomyOrderPredicate createNewInstanceTaxonomyOrderPredicate()
                                                                       throws IllegalEditException

createNewInstanceTaxonomyOrderPredicate.

Specified by:

createNewInstanceTaxonomyOrderPredicate in interface AtomicClass

Returns:

a InstanceTaxonomyOrderPredicate object

Throws:

IllegalEditException - if any.

createNewInstanceTotalOrderPredicate

public InstanceTotalOrderPredicate createNewInstanceTotalOrderPredicate()
                                                                 throws IllegalEditException

createNewInstanceTotalOrderPredicate.

Specified by:

createNewInstanceTotalOrderPredicate in interface AtomicClass

Returns:

a InstanceTotalOrderPredicate object

Throws:

IllegalEditException - if any.

createNewInstanceOntologyOrderPredicate

public InstanceOntologyOrderPredicate createNewInstanceOntologyOrderPredicate()
                                                                       throws IllegalEditException

createNewInstanceOntologyOrderPredicate.

Specified by:

createNewInstanceOntologyOrderPredicate in interface AtomicClass

Returns:

a InstanceOntologyOrderPredicate object

Throws:

IllegalEditException - if any.

createSystemSubClasses

protected void createSystemSubClasses()

createSystemSubClasses.

Specified by:

createSystemSubClasses in class AbstractDataClassImpl

finishEditing

public void finishEditing()
                   throws ClassHierarchyConsistencyException

To instantiate classes it is necessary to know if the class can be edited further. Only finished classes can be instantiated. Therefore, it is necessary to call this method to tell the system that the class is ready defined. Nevertheless, finishing a class can fail because of an inconsistency in the class hierarchy. One of the superclasses is not consistence with this class. The finishing process is distinguished into two parts:

1. it is checked if it is possible to finish the class
2. the class is finished

Therefore, the method AbstractDataClassImpl.finishEditing() first calls the method AbstractDataClassImpl.checkFinishEditing(). Sub classes can overwrite both methods but must follow the instructions describe now.

Sub classes are allowed to overwrite this method to initialize the class, e.g., create internal caches. But the methods must first call the method AbstractDataClassImpl.finishEditing() in the super class. For example:

public void finishEditing() throws ClassHierarchyConsistencyException { super.finishEditing(); // put your own finishing code here }

Specified by:

finishEditing in interface DataClass

Overrides:

finishEditing in class AbstractDataClassImpl

Throws:

ClassHierarchyConsistencyException - if any.

See Also:

DataClass.finishEditing(), AbstractDataClassImpl.checkFinishEditing()

getDefaultValue

public Object getDefaultValue()

The default value is either a defined value with AtomicClass.setDefaultValue(Object) or an arbitrary but valid one.

If the class is not finished, null will return if no default one defined manually. After finishing the class an arbitrary valid value is returned. This must be overwritten by subclasses!

Specified by:

getDefaultValue in interface AtomicClass

Returns:

A valid native object of the class.

See Also:

AtomicClass.getDefaultValue()

setDefaultValue

public void setDefaultValue(Object defaultValue)
                     throws IllegalEditException

Each AtomicClass contains a default value that is used to initialize an AtomicObject. This method is optional and must not be specified.

Specified by:

setDefaultValue in interface AtomicClass

Parameters:

defaultValue - The initiale value of a new AtomicObject

Throws:

IllegalEditException

getInstancePredicate

public InstancePredicate getInstancePredicate()

Returns the instance predicate that is defined in the atomic class

Specified by:

getInstancePredicate in interface AtomicClass

Returns:

InstancePredicate the defined predicate or null if no one is defined.

See Also:

InstanceEnumerationPredicate, InstanceIntervalPredicate

getInstanceEnumerationPredicate

public InstanceEnumerationPredicate getInstanceEnumerationPredicate()

getInstanceEnumerationPredicate.

Specified by:

getInstanceEnumerationPredicate in interface AtomicClass

Returns:

a InstanceEnumerationPredicate object

getInstanceIntervalPredicate

public InstanceIntervalPredicate getInstanceIntervalPredicate()

getInstanceIntervalPredicate.

Specified by:

getInstanceIntervalPredicate in interface AtomicClass

Returns:

a InstanceIntervalPredicate object

getInstanceTaxonomyOrderPredicate

public InstanceTaxonomyOrderPredicate getInstanceTaxonomyOrderPredicate()

getInstanceTaxonomyOrderPredicate.

Specified by:

getInstanceTaxonomyOrderPredicate in interface AtomicClass

Returns:

a InstanceTaxonomyOrderPredicate object

getInstanceTotalOrderPredicate

public InstanceTotalOrderPredicate getInstanceTotalOrderPredicate()

getInstanceTotalOrderPredicate.

Specified by:

getInstanceTotalOrderPredicate in interface AtomicClass

Returns:

a InstanceTotalOrderPredicate object

getInternalDefaultValue

protected Object getInternalDefaultValue()

getInternalDefaultValue.

Returns:

a Object object

getNativeValueFromPredicate

protected AtomicObject getNativeValueFromPredicate()

getNativeValueFromPredicate.

Returns:

a AtomicObject object

hasEnumerationRange

public boolean hasEnumerationRange()

Checks if an InstancePredicate is defined and if the predicate is an InstanceEnumerationPredicate.

Specified by:

hasEnumerationRange in interface AtomicClass

Returns:

true if AtomicClass.getInstancePredicate() is not null and an instance of InstanceEnumerationPredicate.

hasIntervalRange

public boolean hasIntervalRange()

Checks if an InstancePredicate is defined and if the predicate is an InstanceIntervalPredicate.

Specified by:

hasIntervalRange in interface AtomicClass

Returns:

true if AtomicClass.getInstancePredicate() is not null and an instance of InstanceIntervalPredicate.

hasTaxonomyRange

public boolean hasTaxonomyRange()

hasTaxonomyRange.

Specified by:

hasTaxonomyRange in interface AtomicClass

Returns:

a boolean

hasTotalOrderRange

public boolean hasTotalOrderRange()

hasTotalOrderRange.

Specified by:

hasTotalOrderRange in interface AtomicClass

Returns:

a boolean

isAtomic

public boolean isAtomic()

isAtomic.

Specified by:

isAtomic in interface DataClass

Overrides:

isAtomic in class AbstractDataClassImpl

Returns:

true if the data class can be casted to AtomicClass

nativeFromString

public Object nativeFromString(String value)
                        throws InvalidNativeValueException

Converts a String to the native object of the corresponding AtomicObject

Specified by:

nativeFromString in interface AtomicClass

Parameters:

value - The String representation of the value

Returns:

a new Object representing the value

Throws:

InvalidNativeValueException

nativeToString

public String nativeToString(Object value)
                      throws InvalidNativeValueException

Converts a native object of the corresponding AtomicObject to a String.

Specified by:

nativeToString in interface AtomicClass

Parameters:

value - The native object that should be converted.

Returns:

a String representation of the value

Throws:

InvalidNativeValueException

removeInstancePredicate

public InstancePredicate removeInstancePredicate()
                                          throws IllegalEditException

Removes a defined InstancePredicate from the atomic class.

Specified by:

removeInstancePredicate in interface AtomicClass

Returns:

Returns the removed instance predicate or null if none was defined.

Throws:

IllegalEditException

addAtomicObject

public void addAtomicObject(AtomicObject atomicObject)

addAtomicObject.

Specified by:

addAtomicObject in interface AtomicClass

Parameters:

atomicObject - a AtomicObject object

getAtomicObjects

public LinkedList<AtomicObject> getAtomicObjects()

getAtomicObjects.

Specified by:

getAtomicObjects in interface AtomicClass

Returns:

a LinkedList object