com.whitestein.lsps.engine.state.xml

Class GOElement

java.lang.Object

com.whitestein.lsps.engine.state.xml.GOElement

All Implemented Interfaces:

UnmarshalCallback, ElementInProcess, ModelIdentifiable, ModelInstanceAware, XmlEntity

Direct Known Subclasses:

Goal, Plan

public abstract class GOElement
extends Object
implements XmlEntity, ModelInstanceAware, ModelIdentifiable, ElementInProcess

Base class for Goal and Plan.

Author:

rba

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelInstance	modelInstance To be set by subclasses when unmarshalling.
protected Goal	parentGoal To be set by subclasses when unmarshalling.
protected ProcessInstance	processInstance To be set by subclasses when unmarshalling.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GOElement() Creates new empty instance of GOElement.
protected	GOElement(ProcessInstance processInstance, Goal parentGoal, String name) Creates new instance of GOElement.

Method Summary

Modifier and Type	Method and Description
protected void	fireChange(Change change) Notifies about change.
abstract Collection<GOElement>	getChildren() Returns unmodifiable collection of children go elements.
ModelInstance	getModelInstance() Returns the enclosing model instance.
String	getName() Returns name of this GO element.
Goal	getParentGoal() Returns the parent goal or null if this is top goal in its module.
String	getPath() Returns the full path to this element as a string.
QID	getPathQID() Returns the full path to this element as a QID.
ProcessInstance	getProcessInstance() Returns the process instance.
abstract GOElement	makeCopy(ModelInstance targetModelInstance, ProcessInstance targetProcessInstance, Goal targetParentGoal) Returns deep copy.
void	rebind(ModelInstance modelInstance) Re-bind to the provided model instance.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whitestein.lsps.common.jaxb.UnmarshalCallback

postUnmarshal, preUnmarshal

Methods inherited from interface com.whitestein.lsps.engine.state.xml.ModelIdentifiable

getElement, getElementId

Field Detail

processInstance

protected ProcessInstance processInstance

To be set by subclasses when unmarshalling.

modelInstance

protected ModelInstance modelInstance

To be set by subclasses when unmarshalling.

parentGoal

protected Goal parentGoal

To be set by subclasses when unmarshalling.

Constructor Detail

GOElement

protected GOElement()

Creates new empty instance of GOElement.

GOElement

protected GOElement(ProcessInstance processInstance,
                    Goal parentGoal,
                    String name)

Creates new instance of GOElement.

Parameters:

processInstance -

parentGoal -

name -

Throws:

NullPointerException - if processInstance or moduleInstance or name is null

Method Detail

getName

public String getName()

Returns name of this GO element.

Returns:

name of this GO element

getProcessInstance

public ProcessInstance getProcessInstance()

Returns the process instance.

Specified by:

getProcessInstance in interface ElementInProcess

Returns:

the process instance

getParentGoal

public Goal getParentGoal()

Returns the parent goal or null if this is top goal in its module.

Returns:

the parent goal or null if this is top goal in its module

getModelInstance

public ModelInstance getModelInstance()

Returns the enclosing model instance.

Specified by:

getModelInstance in interface ModelInstanceAware

Returns:

the enclosing model instance

rebind

public void rebind(ModelInstance modelInstance)

Description copied from interface: ModelInstanceAware

Re-bind to the provided model instance.

Specified by:

rebind in interface ModelInstanceAware

getChildren

public abstract Collection<GOElement> getChildren()

Returns unmodifiable collection of children go elements.

Returns:

collection of children go elements

fireChange

protected void fireChange(Change change)

Notifies about change.

Parameters:

change -

getPathQID

public QID getPathQID()

Returns the full path to this element as a QID.

Returns:

the full path to this element as a QID

getPath

public String getPath()

Returns the full path to this element as a string.

Returns:

the full path to this element as a string

toString

public String toString()

Overrides:

toString in class Object

makeCopy

public abstract GOElement makeCopy(ModelInstance targetModelInstance,
                                   ProcessInstance targetProcessInstance,
                                   Goal targetParentGoal)

Returns deep copy.

Parameters:

targetModelInstance -

targetProcessInstance -

targetParentGoal -

Returns:

deep copy