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

Interface AtomicClass

All Superinterfaces:

DataClass, PropertyHandler

All Known Subinterfaces:

BooleanClass, ByteArrayClass, ChronologicClass, DateClass, DoubleClass, IntegerClass, NumericClass, StringClass, TimeClass, TimestampClass, URIClass

All Known Implementing Classes:

AtomicClassImpl, BooleanClassImpl, ByteArrayClassImpl, ChronologicClassImpl, DateClassImpl, DoubleClassImpl, IntegerClassImpl, NumericClassImpl, StringClassImpl, TimeClassImpl, TimeStampClassImpl, URIClassImpl

public interface AtomicClass
extends DataClass

The group of Atomic Classes is used to store exact one value. The counterpart in programming languages are data types like integer, double, or Boolean in Java. A specialisation can restrict the value ranges with intervals or enumerations. Intervals can only be used for Atomic classes that have totally ordered instances like instances of sub-classes from the NumericClass or the ChronologicClass. E.g., a class "Age" would be a sub-class of IntegerClass, restricted to values between zero and 150. These intervals are just restrictions of the possible values of an attribute with an Atomic Class as type and not the definition of intervals in instances of a class. Of course, this is also possible by using the data class IntervalClass. Enumerations define fix values for a class, e.g., a class "Colour" would be realised as sub-class of StringClass with the fixed values "red", "green", and "blue". Such enumeration values can be ordered totally or arranged in taxonomies. An exceptional role plays the Atomic Class ByteArrayClass that can be used to store more complex data objects like images or documents. Internally, it is of course an array of bytes, but conceptually it is used as one value, e.g., one image.

Atomic classes can have only one InstancePredicate that is automatically assigned if it is created by one of the factory methods createNewInstanceEnumerationPredicate() or createNewInstanceIntervalPredicate().

All AtomicClasses provide methods to convert the content objects to a String and from a String. See the methods nativeFromString(String) and nativeToString(Object). For example, the XML parser using this method to convert the value of an AtomicObject into a String and back.

Atomic classes can have only one InstancePredicate that is automatically assigned if it is created by one of the factory methods createNewInstanceEnumerationPredicate() or createNewInstanceIntervalPredicate().

All AtomicClasses provide methods to convert the content objects to a String and from a String. See the methods nativeFromString(String) and nativeToString(Object). For example, the XML parser using this method to convert the value of an AtomicObject into a String and back.

  AtomicObject object = ...;
  xmlWriter.append("value", object.getAtomicClass().nativeToString(
  object.getNativeObject()));
 

Never use the Object.toString() method because this method is for debugging purposes and results additional informations.

Author:

Rainer Maximini

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLASS_NAME	Constant CLASS_NAME="Atomic"
static String	COMPONENT	Component: "cake.data.model" (LogComponentIdentifier.COMPONENT)
static String	COMPONENT_KEY	Component-Key: "04" (LogComponentIdentifier.COMPONENT_KEY_ATOMICCLASS)
static String	LOG_CANNOT_HANDLE_NATIVE_VALUES	This class can not handle native values.
static String	LOG_INTERVAL_BORDERS_INCOMPATIBLE	The interval-borders in this class are incompatible.
static String	LOG_PARSING_NATIVE_VALUE	The native value could not be converted to match this class.
static String	LOG_UNKNOWN_NATIVE_VALUE	The native-value class is unknown.
static String	LOG_UNKNOWN_VALUE_IN_ORDER	The value in an InstanceValueOrderPredicate is not defined in the InstanceEnumerationPredicate.
static String	LOG_VALUE_RANGE_INCOMPATIBLE	Value is not compatible with the class' value range.

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
void	addAtomicObject(AtomicObject atomicObject)	addAtomicObject.
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.
LinkedList<AtomicObject>	getAtomicObjects()	getAtomicObjects.
Object	getDefaultValue()	The default value is either a defined value with 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.
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.
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 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

Constant CLASS_NAME="Atomic"

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: "04" (LogComponentIdentifier.COMPONENT_KEY_ATOMICCLASS)

See Also:

Constant Field Values

LOG_CANNOT_HANDLE_NATIVE_VALUES

static final String LOG_CANNOT_HANDLE_NATIVE_VALUES

This class can not handle native values.

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

See Also:

Constant Field Values

LOG_INTERVAL_BORDERS_INCOMPATIBLE

static final String LOG_INTERVAL_BORDERS_INCOMPATIBLE

The interval-borders in this class are incompatible.

0. Component: COMPONENT
1. Key: "0401"
2. this
3. Lower border
4. Upper border

See Also:

Constant Field Values

LOG_PARSING_NATIVE_VALUE

static final String LOG_PARSING_NATIVE_VALUE

The native value could not be converted to match this class.

0. Component: COMPONENT
1. Key: "0403"
2. this
3. Native value

See Also:

Constant Field Values

LOG_UNKNOWN_NATIVE_VALUE

static final String LOG_UNKNOWN_NATIVE_VALUE

The native-value class is unknown.

0. Component: COMPONENT
1. Key: "0402"
2. this
3. Native-value class

See Also:

Constant Field Values

LOG_UNKNOWN_VALUE_IN_ORDER

static final String LOG_UNKNOWN_VALUE_IN_ORDER

The value in an InstanceValueOrderPredicate is not defined in the InstanceEnumerationPredicate.

0. Component: COMPONENT
1. Key: "0405"
2. this
3. InstanceValueOrderPredicate
4. the value: AtomicObject

See Also:

Constant Field Values

LOG_VALUE_RANGE_INCOMPATIBLE

static final String LOG_VALUE_RANGE_INCOMPATIBLE

Value is not compatible with the class' value range.

0. Component: COMPONENT
1. Key: "0400"
2. this
3. Value

See Also:

Constant Field Values

Method Detail

createNewInstanceEnumerationPredicate

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. *

Returns:

The new instance of InstanceEnumerationPredicate.

Throws:

IllegalEditException

createNewInstanceIntervalPredicate

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.

Returns:

The new instance of InstanceIntervalPredicate.

Throws:

IllegalEditException

createNewInstanceTaxonomyOrderPredicate

InstanceTaxonomyOrderPredicate createNewInstanceTaxonomyOrderPredicate()
                                                                throws IllegalEditException

createNewInstanceTaxonomyOrderPredicate.

Returns:

a InstanceTaxonomyOrderPredicate object

Throws:

IllegalEditException - if any.

createNewInstanceTotalOrderPredicate

InstanceTotalOrderPredicate createNewInstanceTotalOrderPredicate()
                                                          throws IllegalEditException

createNewInstanceTotalOrderPredicate.

Returns:

a InstanceTotalOrderPredicate object

Throws:

IllegalEditException - if any.

createNewInstanceOntologyOrderPredicate

InstanceOntologyOrderPredicate createNewInstanceOntologyOrderPredicate()
                                                                throws IllegalEditException

createNewInstanceOntologyOrderPredicate.

Returns:

a InstanceOntologyOrderPredicate object

Throws:

IllegalEditException - if any.

getDefaultValue

Object getDefaultValue()

The default value is either a defined value with 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.

Returns:

A valid native object of the class.

setDefaultValue

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.

Parameters:

defaultValue - The initiale value of a new AtomicObject

Throws:

IllegalEditException

getInstancePredicate

InstancePredicate getInstancePredicate()

Returns the instance predicate that is defined in the atomic class

Returns:

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

See Also:

InstanceEnumerationPredicate, InstanceIntervalPredicate

getInstanceEnumerationPredicate

InstanceEnumerationPredicate getInstanceEnumerationPredicate()

getInstanceEnumerationPredicate.

Returns:

a InstanceEnumerationPredicate object

getInstanceIntervalPredicate

InstanceIntervalPredicate getInstanceIntervalPredicate()

getInstanceIntervalPredicate.

Returns:

a InstanceIntervalPredicate object

getInstanceTaxonomyOrderPredicate

InstanceTaxonomyOrderPredicate getInstanceTaxonomyOrderPredicate()

getInstanceTaxonomyOrderPredicate.

Returns:

a InstanceTaxonomyOrderPredicate object

getInstanceTotalOrderPredicate

InstanceTotalOrderPredicate getInstanceTotalOrderPredicate()

getInstanceTotalOrderPredicate.

Returns:

a InstanceTotalOrderPredicate object

hasEnumerationRange

boolean hasEnumerationRange()

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

Returns:

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

hasIntervalRange

boolean hasIntervalRange()

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

Returns:

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

hasTaxonomyRange

boolean hasTaxonomyRange()

hasTaxonomyRange.

Returns:

a boolean

hasTotalOrderRange

boolean hasTotalOrderRange()

hasTotalOrderRange.

Returns:

a boolean

nativeFromString

Object nativeFromString(String value)
                 throws InvalidNativeValueException

Converts a String to the native object of the corresponding AtomicObject

Parameters:

value - The String representation of the value

Returns:

a new Object representing the value

Throws:

InvalidNativeValueException

nativeToString

String nativeToString(Object value)
               throws InvalidNativeValueException

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

Parameters:

value - The native object that should be converted.

Returns:

a String representation of the value

Throws:

InvalidNativeValueException

removeInstancePredicate

InstancePredicate removeInstancePredicate()
                                   throws IllegalEditException

Removes a defined InstancePredicate from the atomic class.

Returns:

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

Throws:

IllegalEditException

addAtomicObject

void addAtomicObject(AtomicObject atomicObject)

addAtomicObject.

Parameters:

atomicObject - a AtomicObject object

getAtomicObjects

LinkedList<AtomicObject> getAtomicObjects()

getAtomicObjects.

Returns:

a LinkedList object