Package de.uni_trier.wi2.procake.data.object.impl

Class DataObjectImpl

java.lang.Object

de.uni_trier.wi2.procake.data.object.impl.DataObjectImpl

All Implemented Interfaces:

DataObject, PropertyHandler

Direct Known Subclasses:

AbstractWorkflowItemObjectImpl, AggregateObjectImpl, AtomicObjectImpl, CollectionObjectImpl, IntervalObjectImpl, NESTGraphItemObjectImpl, NESTGraphObjectImpl, VoidObjectImpl

public abstract class DataObjectImpl
extends Object
implements DataObject

Author:

Rainer Maximini

Field Summary

Fields

Modifier and Type	Field	Description
protected String	objectId

Constructor Summary

Constructors

Constructor	Description
DataObjectImpl()
DataObjectImpl(DataClass dataClass)

Method Summary

Modifier and Type	Method	Description
void	addProperty(PropertyTreeNode node)	Add a property to the property tree.
void	addProperty(String name, String value)	Add a property to the property tree.
void	assertSameValueAsIn(DataObject object)
DataObject	copy()	Makes a deep copy of the data object
void	deepCopy(DataObjectImpl dataObject)
List<String>	getAllProperties(String key)	Searches for all property values within the property tree.
List<PropertyTreeNode>	getAllPropertyNodes(String key)	Searches for all property nodes within the property tree.
DataClass	getDataClass()
String	getId()
Model	getModel()	Each object knows to which model it belongs.
String	getProperty(String key)	Gets the value of the node that has the given name and is found first.
String[]	getPropertyNames()	To receive all properties that are set by PropertyHandler.addProperty(String, String) use this method.
PropertyTreeNode	getPropertyNode(String key)	Search for a property node within the whole tree of properties.
PropertyTreeNode	getPropertyRootNode()	Returns the propertyRootNode of the implementing object.
boolean	hasClassName(String className)	Check if the object's data class has the given class name.
boolean	hasProperties()	Tests, if the implementing object has properties.
boolean	hasSameValueAsIn(DataObject object)	This method makes a deep compare.
boolean	hasSystemClassName(String systemClassName)	Check if the object's data class has the given system class name.
boolean	isAggregate()
boolean	isAtomic()
boolean	isBoolean()
boolean	isByteArray()
boolean	isChronologic()
boolean	isCollection()
boolean	isDataflowWrapper()
boolean	isDataReference()
boolean	isDate()
boolean	isDouble()
boolean	isInteger()
boolean	isInterval()
boolean	isKindOf(DataClass anotherClass)	Check if the object is an instance of the given DataClass or of some of its sub-classes.
boolean	isList()
boolean	isMemberOf(DataClass anotherClass)	Check if this object can be referenced from the given DataClass
boolean	isNESTConstraintEdge()
boolean	isNESTControlflowEdge()
boolean	isNESTControlflowNode()
boolean	isNESTDataflowEdge()
boolean	isNESTDataNode()
boolean	isNESTEdge()
boolean	isNESTGraph()
boolean	isNESTNode()
boolean	isNESTPartOfEdge()
boolean	isNESTSequenceNode()
boolean	isNESTSequentialWorkflow()
boolean	isNESTSubWorkflowNode()
boolean	isNESTTaskNode()
boolean	isNESTWorkflow()
boolean	isNESTWorkflowNode()
boolean	isNode()
boolean	isNumeric()
boolean	isSequence()
boolean	isSet()
boolean	isString()
boolean	isSubWorkflow()
boolean	isTask()
boolean	isTime()
boolean	isTimestamp()
boolean	isUnion()
boolean	isURI()
boolean	isVoid()
boolean	isWorkflow()
void	removeId()	Removes the given objectId from the set of ids.
String	removeProperty(String name)	Remove any node from the property tree.
void	setDataClass(DataClass dataClass)
void	setId(String objectId)	Adds the given objectId to the set of ids.
String	toDetailedString()	Returns a detailed String, if the output of the standard toString() method would be to long.
String	toString()
String	toXML()	Converts the data object to XML

Methods inherited from class java.lang.Object

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

Field Detail

objectId

protected String objectId

Constructor Detail

DataObjectImpl

public DataObjectImpl()

DataObjectImpl

public DataObjectImpl(DataClass dataClass)

Method Detail

getDataClass

public DataClass getDataClass()

Specified by:

getDataClass in interface DataObject

Returns:

The data class of the object.

setDataClass

public void setDataClass(DataClass dataClass)

Specified by:

setDataClass in interface DataObject

getId

public String getId()

Specified by:

getId in interface DataObject

Returns:

objectId of the given base *

See Also:

de.uni_trier.wi2.procake.data.object

setId

public void setId(String objectId)

Description copied from interface: DataObject

Adds the given objectId to the set of ids.

Specified by:

setId in interface DataObject

Parameters:

objectId - that will be added to the set of ids

See Also:

de.uni_trier.wi2.procake.data.object

getModel

public Model getModel()

Description copied from interface: DataObject

Each object knows to which model it belongs.

Specified by:

getModel in interface DataObject

Returns:

The data model to that the object belongs.

getPropertyRootNode

public PropertyTreeNode getPropertyRootNode()

Description copied from interface: PropertyHandler

Returns the propertyRootNode of the implementing object.

Specified by:

getPropertyRootNode in interface PropertyHandler

Returns:

the propertyRootNode if set. Null otherwise.

getPropertyNode

public PropertyTreeNode getPropertyNode(String key)

Description copied from interface: PropertyHandler

Search for a property node within the whole tree of properties. The first node with a given name will be returned. The generic root node cannot be returned. The used search algorithm to iterate the property tree is BFS.

Specified by:

getPropertyNode in interface PropertyHandler

Parameters:

key - the name of the property to search for

Returns:

the found property node, or null, if there are no properties or no node has this key

getProperty

public String getProperty(String key)

Description copied from interface: PropertyHandler

Gets the value of the node that has the given name and is found first. If the property does not exists, null will be returned.

Specified by:

getProperty in interface PropertyHandler

Parameters:

key - The name of the property.

Returns:

The property value or null if the property does not exists.

See Also:

PropertyHandler.getPropertyNode(String)

getPropertyNames

public String[] getPropertyNames()

Description copied from interface: PropertyHandler

To receive all properties that are set by PropertyHandler.addProperty(String, String) use this method. Every name contained in the complete tree will be considered. The result will never be null.

Specified by:

getPropertyNames in interface PropertyHandler

Returns:

An array of defined property names.

removeProperty

public String removeProperty(String name)

Description copied from interface: PropertyHandler

Remove any node from the property tree. The first node to be found with this name, will be removed (including all children).

Specified by:

removeProperty in interface PropertyHandler

Parameters:

name - the name of the node to be removed

Returns:

the value of the removed node, or null, if no node could be removed

addProperty

public void addProperty(PropertyTreeNode node)

Description copied from interface: PropertyHandler

Add a property to the property tree. This property node (or subtree) will be added right below the generic root.

Specified by:

addProperty in interface PropertyHandler

Parameters:

node - the node to be added

addProperty

public void addProperty(String name,
                        String value)

Description copied from interface: PropertyHandler

Add a property to the property tree. This property node (or subtree) will be added right below the generic root.

Specified by:

addProperty in interface PropertyHandler

Parameters:

name - the name of the node to add

value - the value of the node to add

See Also:

PropertyHandler.addProperty(PropertyTreeNode)

getAllPropertyNodes

public List<PropertyTreeNode> getAllPropertyNodes(String key)

Description copied from interface: PropertyHandler

Searches for all property nodes within the property tree. The result will never be null (but could be an empty set).

Specified by:

getAllPropertyNodes in interface PropertyHandler

Parameters:

key - the key of the property

Returns:

a set with the found property nodes

getAllProperties

public List<String> getAllProperties(String key)

Description copied from interface: PropertyHandler

Searches for all property values within the property tree. The result will never be null (but could be an empty set).

Specified by:

getAllProperties in interface PropertyHandler

Parameters:

key - the key of the property

Returns:

a set with the found property nodes

hasProperties

public boolean hasProperties()

Description copied from interface: PropertyHandler

Tests, if the implementing object has properties. This can be tested by looking for a generic root node.

Specified by:

hasProperties in interface PropertyHandler

Returns:

true, if a property is set, false otherwise.

isAggregate

public boolean isAggregate()

Specified by:

isAggregate in interface DataObject

Returns:

true if the data class can be casted to AggregateClass

isAtomic

public boolean isAtomic()

Specified by:

isAtomic in interface DataObject

Returns:

true if the data class can be casted to AtomicClass

isBoolean

public boolean isBoolean()

Specified by:

isBoolean in interface DataObject

Returns:

true if the data class can be casted to BooleanClass

isByteArray

public boolean isByteArray()

Specified by:

isByteArray in interface DataObject

Returns:

true if the data class can be casted to ByteArrayClass

isChronologic

public boolean isChronologic()

Specified by:

isChronologic in interface DataObject

Returns:

true if the data class can be casted to ChronologicClass

isCollection

public boolean isCollection()

Specified by:

isCollection in interface DataObject

Returns:

true if the data class can be casted to CollectionClass

isDate

public boolean isDate()

Specified by:

isDate in interface DataObject

Returns:

true if the data class can be casted to DateClass

isDouble

public boolean isDouble()

Specified by:

isDouble in interface DataObject

Returns:

true if the data class can be casted to DoubleClass

isInteger

public boolean isInteger()

Specified by:

isInteger in interface DataObject

Returns:

true if the data class can be casted to IntegerClass

isInterval

public boolean isInterval()

Specified by:

isInterval in interface DataObject

Returns:

true if the data class can be casted to IntervalClass

isTask

public boolean isTask()

Specified by:

isTask in interface DataObject

Returns:

true if the data class can be casted to TaskClass

isNode

public boolean isNode()

Specified by:

isNode in interface DataObject

Returns:

true if the data class can be casted to NodeClass

isDataReference

public boolean isDataReference()

Specified by:

isDataReference in interface DataObject

Returns:

true if the data class can be casted to DataReferenceClass

isWorkflow

public boolean isWorkflow()

Specified by:

isWorkflow in interface DataObject

Returns:

true if the data class can be casted to WorkflowClass

isSubWorkflow

public boolean isSubWorkflow()

Specified by:

isSubWorkflow in interface DataObject

Returns:

true if the data class can be casted to SubWorkflowClass

isNESTGraph

public boolean isNESTGraph()

Specified by:

isNESTGraph in interface DataObject

Returns:

true if the data class can be casted to NESTGraphClass

isNESTSequentialWorkflow

public boolean isNESTSequentialWorkflow()

Specified by:

isNESTSequentialWorkflow in interface DataObject

Returns:

true if the data class can be casted to NESTSequentialWorkflowClass

isNESTWorkflow

public boolean isNESTWorkflow()

Specified by:

isNESTWorkflow in interface DataObject

Returns:

true if the data class can be casted to NESTWorkflowClass

isNESTNode

public boolean isNESTNode()

Specified by:

isNESTNode in interface DataObject

Returns:

true if the data class can be casted to NESTNodeClass

isNESTDataNode

public boolean isNESTDataNode()

Specified by:

isNESTDataNode in interface DataObject

Returns:

true if the data class can be casted to NESTDataNodeClass

isNESTTaskNode

public boolean isNESTTaskNode()

Specified by:

isNESTTaskNode in interface DataObject

Returns:

true if the data class can be casted to NESTTaskNodeClass

isNESTSequenceNode

public boolean isNESTSequenceNode()

Specified by:

isNESTSequenceNode in interface DataObject

Returns:

true if the data class can be casted to NESTTaskNodeClass or NESTControlflowNodeClass

isNESTWorkflowNode

public boolean isNESTWorkflowNode()

Specified by:

isNESTWorkflowNode in interface DataObject

Returns:

true if the data class can be casted to NESTWorkflowNodeClass

isNESTSubWorkflowNode

public boolean isNESTSubWorkflowNode()

Specified by:

isNESTSubWorkflowNode in interface DataObject

Returns:

true if the data class can be casted to NESTSubWorkflowNodeClass

isNESTControlflowNode

public boolean isNESTControlflowNode()

Specified by:

isNESTControlflowNode in interface DataObject

Returns:

true if the data class can be casted to NESTControlflowNodeClass

isNESTEdge

public boolean isNESTEdge()

Specified by:

isNESTEdge in interface DataObject

Returns:

true if the data class can be casted to NESTEdgeClass

isNESTDataflowEdge

public boolean isNESTDataflowEdge()

Specified by:

isNESTDataflowEdge in interface DataObject

Returns:

true if the data class can be casted to NESTDataflowEdgeClass

isNESTControlflowEdge

public boolean isNESTControlflowEdge()

Specified by:

isNESTControlflowEdge in interface DataObject

Returns:

true if the data class can be casted to NESTControlflowEdgeClass

isNESTConstraintEdge

public boolean isNESTConstraintEdge()

Specified by:

isNESTConstraintEdge in interface DataObject

Returns:

true if the data class can be casted to NESTConstraintEdgeClass

isNESTPartOfEdge

public boolean isNESTPartOfEdge()

Specified by:

isNESTPartOfEdge in interface DataObject

Returns:

true if the data class can be casted to NESTPartOfEdgeClass

isSequence

public boolean isSequence()

Specified by:

isSequence in interface DataObject

Returns:

true if the data class can be casted to SequenceClass

isDataflowWrapper

public boolean isDataflowWrapper()

Specified by:

isDataflowWrapper in interface DataObject

Returns:

true if the data class can be casted to DataflowWrapperClass

isKindOf

public boolean isKindOf(DataClass anotherClass)

Description copied from interface: DataObject

Check if the object is an instance of the given DataClass or of some of its sub-classes.

Specified by:

isKindOf in interface DataObject

Returns:

true if the data class of this object is a subclass of the given class.

hasSystemClassName

public boolean hasSystemClassName(String systemClassName)

Description copied from interface: DataObject

Check if the object's data class has the given system class name.

Specified by:

hasSystemClassName in interface DataObject

Parameters:

systemClassName - system class name

Returns:

true if the data class of this object has the given system class name.

hasClassName

public boolean hasClassName(String className)

Description copied from interface: DataObject

Check if the object's data class has the given class name.

Specified by:

hasClassName in interface DataObject

Parameters:

className - class name

Returns:

true if the data class of this object has the given class name.

isList

public boolean isList()

Specified by:

isList in interface DataObject

Returns:

true if the data class can be casted to ListClass

isMemberOf

public boolean isMemberOf(DataClass anotherClass)

Description copied from interface: DataObject

Check if this object can be referenced from the given DataClass

Specified by:

isMemberOf in interface DataObject

Returns:

true if the data class of this objects is used in the given class.

isNumeric

public boolean isNumeric()

Specified by:

isNumeric in interface DataObject

Returns:

true if the data class can be casted to NumericClass

isURI

public boolean isURI()

Specified by:

isURI in interface DataObject

Returns:

true if the data class can be casted to URIClass

isSet

public boolean isSet()

Specified by:

isSet in interface DataObject

Returns:

true if the data class can be casted to SetClass

isString

public boolean isString()

Specified by:

isString in interface DataObject

Returns:

true if the data class can be casted to StringClass

isTime

public boolean isTime()

Specified by:

isTime in interface DataObject

Returns:

true if the data class can be casted to TimeClass

isTimestamp

public boolean isTimestamp()

Specified by:

isTimestamp in interface DataObject

Returns:

true if the data class can be casted to TimestampClass

isUnion

public boolean isUnion()

Specified by:

isUnion in interface DataObject

Returns:

true if the data class can be casted to UnionClass

isVoid

public boolean isVoid()

Specified by:

isVoid in interface DataObject

Returns:

true if the data class can be casted to VoidClass

removeId

public void removeId()

Description copied from interface: DataObject

Removes the given objectId from the set of ids. If the given objectId not exists or is null nothing will happen.

Specified by:

removeId in interface DataObject

toString

public String toString()

Overrides:

toString in class Object

deepCopy

public void deepCopy(DataObjectImpl dataObject)

copy

public DataObject copy()

Description copied from interface: DataObject

Makes a deep copy of the data object

Specified by:

copy in interface DataObject

Returns:

deep copy of the data object

toXML

public String toXML()

Description copied from interface: DataObject

Converts the data object to XML

Specified by:

toXML in interface DataObject

Returns:

XML String of the data object

toDetailedString

public String toDetailedString()

Description copied from interface: DataObject

Returns a detailed String, if the output of the standard toString() method would be to long.

Specified by:

toDetailedString in interface DataObject

Returns:

assertSameValueAsIn

public void assertSameValueAsIn(DataObject object)
                         throws AssertSameValueAsInException

Specified by:

assertSameValueAsIn in interface DataObject

Throws:

AssertSameValueAsInException

hasSameValueAsIn

public boolean hasSameValueAsIn(DataObject object)

Description copied from interface: DataObject

This method makes a deep compare. For atomic objects this is equal to the equal method. For sets, lists, aggregates, and others a deeper comparision is performed.

Specified by:

hasSameValueAsIn in interface DataObject

Parameters:

object - The object to compare.

Returns:

true if the given object has the same value(s) as this one.