com.whitestein.lsps.engine.state.xml

Class Variable

java.lang.Object

com.whitestein.lsps.engine.state.xml.Variable

All Implemented Interfaces:

UnmarshalCallback, ModelIdentifiable, ModelInstanceAware, XmlEntity

public class Variable
extends Object
implements XmlEntity, ModelInstanceAware, ModelIdentifiable

Entity representing instance of a variable.

Author:

rba

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Variable() Creates new empty instance of Variable.
	Variable(Context context, String name, String type) Creates new instance of Variable.
	Variable(Context context, String name, String type, Value value, boolean isReadOnly) Creates new instance of Variable.

Method Summary

Modifier and Type	Method and Description
Type	getCompiledType(ModelProviderClientService modelProviderService) Returns the compiled type.
Context	getContext() Returns context.
com.whitestein.lsps.model.Variable	getElement(ModelProviderClientService modelProviderService) Returns the model element.
String	getElementId(ModelProviderClientService modelProviderService) Returns the model element id.
Long	getInitialVersion() Returns initial version.
ModelInstance	getModelInstance() Returns the model instance.
String	getName() Returns variable name.
String	getType() Returns the type.
Value	getValue() Returns variable value.
Long	getVersion() Returns version.
boolean	isExpressionLocal() Returns true is the variable is defined in an expression.
boolean	isInternal() Returns true if this variable is internal.
boolean	isReadOnly() Returns true if variable is read only.
Variable	makeCopy(ModelInstance targetModelInstance, Context targetContext) Returns deep copy.
void	postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent) Callback method invoked after unmarshalling XML data into target.
void	preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent) Callback method invoked before unmarshalling into target.
void	rebind(ModelInstance modelInstance) Re-binds to a model instance.
void	setInternal(boolean internal) Sets the internal flag of this variable.
void	setIsExpressionLocal(Boolean isExpressionLocal) Sets the flag that the the variable is defined in an expression
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Variable

protected Variable()

Creates new empty instance of Variable.

Variable

public Variable(Context context,
                String name,
                String type)

Creates new instance of Variable.

Parameters:

context -

name -

type -

Throws:

NullPointerException - if context or @{code name} is null

Variable

public Variable(Context context,
                String name,
                String type,
                Value value,
                boolean isReadOnly)

Creates new instance of Variable.

Parameters:

context -

name -

type -

value -

isReadOnly -

Throws:

NullPointerException - if context or name or value

Method Detail

getName

public String getName()

Returns variable name.

Returns:

variable name

getType

public String getType()

Returns the type.

Returns:

the type

getContext

public Context getContext()

Returns context.

Returns:

context

getCompiledType

public Type getCompiledType(ModelProviderClientService modelProviderService)

Returns the compiled type.

Parameters:

modelProviderService -

Returns:

the compiled type

getValue

public Value getValue()

Returns variable value.

Returns:

variable value

getElement

public com.whitestein.lsps.model.Variable getElement(ModelProviderClientService modelProviderService)

Description copied from interface: ModelIdentifiable

Returns the model element.

Specified by:

getElement in interface ModelIdentifiable

Returns:

the model element

getElementId

public String getElementId(ModelProviderClientService modelProviderService)

Description copied from interface: ModelIdentifiable

Returns the model element id.

Specified by:

getElementId in interface ModelIdentifiable

Returns:

the model element id

isInternal

public boolean isInternal()

Returns true if this variable is internal.

Returns:

true if this variable is internal

setInternal

public void setInternal(boolean internal)

Sets the internal flag of this variable.

Parameters:

internal -

isExpressionLocal

public boolean isExpressionLocal()

Returns true is the variable is defined in an expression.

Returns:

true is the variable is defined in an expression

setIsExpressionLocal

public void setIsExpressionLocal(Boolean isExpressionLocal)

Sets the flag that the the variable is defined in an expression

Parameters:

isExpressionLocal -

getInitialVersion

public Long getInitialVersion()

Returns initial version.

Returns:

initial version

getVersion

public Long getVersion()

Returns version.

Returns:

version

isReadOnly

public boolean isReadOnly()

Returns true if variable is read only.

Returns:

true if variable is read only

toString

public String toString()

Overrides:

toString in class Object

getModelInstance

public ModelInstance getModelInstance()

Description copied from interface: ModelInstanceAware

Returns the model instance.

Specified by:

getModelInstance in interface ModelInstanceAware

Returns:

the model instance

preUnmarshal

public void preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                         Object parent)

Description copied from interface: UnmarshalCallback

Callback method invoked before unmarshalling into target.

This method is invoked immediately after target was created and before the unmarshalling of this object begins.

Specified by:

preUnmarshal in interface UnmarshalCallback

parent - instance of JAXB mapped class that will eventually reference target. null when target is root element.

postUnmarshal

public void postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                          Object parent)

Description copied from interface: UnmarshalCallback

Callback method invoked after unmarshalling XML data into target.

This method is invoked after all the properties (except IDREF) are unmarshalled into target, but before target is set into its parent object.

Specified by:

postUnmarshal in interface UnmarshalCallback

parent - instance of JAXB mapped class that will reference target. null when target is root element.

rebind

public void rebind(ModelInstance modelInstance)

Re-binds to a model instance.

Specified by:

rebind in interface ModelInstanceAware

Parameters:

modelInstance -

makeCopy

public Variable makeCopy(ModelInstance targetModelInstance,
                         Context targetContext)

Returns deep copy.

Parameters:

targetModelInstance -

targetContext -

Returns:

deep copy