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

Interface DataflowWrapperObject

All Superinterfaces:

AbstractWorkflowItemObject, DataObject, PropertyHandler

All Known Implementing Classes:

DataflowWrapperObjectImpl

public interface DataflowWrapperObject
extends AbstractWorkflowItemObject

Interface of a dataflow-object used to represent dataitems of a workflow. CAKE III - Extension. Represents CAKE I - dataitems, which can be connected to tasks of a workflow. A DataflowWrapper is a tree structure containing a hierarchy of DataflowElements. Several DataflowElements may form a aggregate which leads to a new node above the DataflowElements.

A workflow may contain several trees of DataflowElements but also atomic DataflowElements.

Any inheritance of this method should be prohibited, so every workflow has only one context space for DataflowElements. DO NOT CALL this method on anything else than the WorkflowObject.

Author:

Sebastian Goerg

Method Summary

Modifier and Type	Method	Description
boolean	addChild(DataflowWrapperObject element)	Adds a new child.
DataflowWrapperObject	deepSearchChild(String id)	Searches the whole tree-structure for the DataflowWrapperObject with the given id and returns it.
DataflowWrapperObject	getChild(String id)	Returns the child with the given id.
List<DataflowWrapperObject>	getChilds()	Returns the list of childs for this object.
DataObject	getDataObject()	Returns the CAKE1-DataObject attached to the DataflowWrapperObject.
String	getName()
DataflowWrapperObject	getParent()	Returns the parent-object of the DataflowWrapperObject.
boolean	hasChilds()	Checks if childs are available for this object.
boolean	isReferencedAsInput()	Checks if the dataobject is referenced as an input-dataobject for tasks.
boolean	isReferencedAsOutput()	Checks if the dataobject is referenced as an output-dataobject for tasks.
DataflowWrapperObject	removeChild(String id)	Removes the child with the given id.
void	setDataObject(DataObject dataObject)	Sets the given CAKE1-DataObject to the DataflowWrapperObject.
void	setName(String name)
void	setParent(DataflowWrapperObject parent)	Sets the parent-object of the DataflowWrapperObject.

Methods inherited from interface de.uni_trier.wi2.procake.data.object.wf.AbstractWorkflowItemObject

getSemanticDescriptor, getWFItemId, getWorkflow, setSemanticDescriptor, setWFItemId, setWorkflow

Methods inherited from interface de.uni_trier.wi2.procake.data.object.DataObject

assertSameValueAsIn, copy, getDataClass, getId, getModel, hasClassName, hasSameValueAsIn, hasSystemClassName, isAggregate, isAtomic, isBoolean, isByteArray, isChronologic, isCollection, isDataflowWrapper, isDataReference, isDate, isDouble, isInteger, isInterval, isKindOf, isList, isMemberOf, isNESTConstraintEdge, isNESTControlflowEdge, isNESTControlflowNode, isNESTDataflowEdge, isNESTDataNode, isNESTEdge, isNESTGraph, isNESTNode, isNESTPartOfEdge, isNESTSequenceNode, isNESTSequentialWorkflow, isNESTSubWorkflowNode, isNESTTaskNode, isNESTWorkflow, isNESTWorkflowNode, isNode, isNumeric, isSequence, isSet, isString, isSubWorkflow, isTask, isTime, isTimestamp, isUnion, isURI, isVoid, isWorkflow, removeId, setDataClass, setId, toDetailedString, toXML

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

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

Method Detail

getDataObject

DataObject getDataObject()

Returns the CAKE1-DataObject attached to the DataflowWrapperObject.

Returns:

The CAKE1-DataObject.

setDataObject

void setDataObject(DataObject dataObject)

Sets the given CAKE1-DataObject to the DataflowWrapperObject.

Parameters:

dataObject - The CAKE1-DataObject to set.

getName

String getName()

Returns:

the name

setName

void setName(String name)

Parameters:

name - the name to set

getParent

DataflowWrapperObject getParent()

Returns the parent-object of the DataflowWrapperObject.

Returns:

The parent-object.

setParent

void setParent(DataflowWrapperObject parent)

Sets the parent-object of the DataflowWrapperObject.

Parameters:

parent - The new parent-object.

addChild

boolean addChild(DataflowWrapperObject element)

Adds a new child.

Parameters:

element - The new child to add.

Returns:

TRUE, if the process was successfull.

deepSearchChild

DataflowWrapperObject deepSearchChild(String id)

Searches the whole tree-structure for the DataflowWrapperObject with the given id and returns it.

Parameters:

id - The id of the item to search for.

Returns:

An Object, if an item with this id was found. Null otherwise.

hasChilds

boolean hasChilds()

Checks if childs are available for this object.

Returns:

TRUE, if childs are available. FALSE otherwise.

getChilds

List<DataflowWrapperObject> getChilds()

Returns the list of childs for this object.

Returns:

getChild

DataflowWrapperObject getChild(String id)

Returns the child with the given id.

Parameters:

id - The id of the child to get.

Returns:

The object with the given id, NULL otherwise.

removeChild

DataflowWrapperObject removeChild(String id)

Removes the child with the given id. The item with this id, has to be a direct child of this object. Subitems are not inspected and therefore not removed.

Parameters:

id - The id of the object, which has to be removed.

isReferencedAsInput

boolean isReferencedAsInput()

Checks if the dataobject is referenced as an input-dataobject for tasks.

Returns:

TRUE, if the dataobject is referenced as input-dataobject for one or more tasks. FALSE otherwise.

isReferencedAsOutput

boolean isReferencedAsOutput()

Checks if the dataobject is referenced as an output-dataobject for tasks.

Returns:

TRUE, if the dataobject is referenced as output-dataobject for one or more tasks. FALSE otherwise.