com.whitestein.lsps.engine.state.xml

Class Variable

java.lang.Object

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

Direct Known Subclasses:

ReadonlyVariable, WritableVariable

public abstract class Variable
extends Object

Entity representing instance of a variable.

Author:

rba

Field Summary

Fields

Modifier and Type	Field and Description
protected Value	value

Constructor Summary

Constructors

Modifier	Constructor and Description
	Variable(String name, String type) Creates new instance of Variable.
protected	Variable(String name, String type, byte flags, Value value)
	Variable(String name, String type, Value value) Creates new instance of Variable.
protected	Variable(SVariable source, ModelInstance modelInstance)

Method Summary

Modifier and Type	Method and Description
protected Type	compileType(Context context, ModelProvider modelProvider)
void	convertToDirectReferences() Converts the value to a direct reference.
protected void	fillSerializable(SVariable s, SModelInstance smi, MarshallerConfig config)
abstract Type	getCachedCompiledType() Returns the cached compiled type, if it is stored.
abstract Type	getCompiledType(Context context, ModelProvider modelProvider) Returns the compiled type.
String	getElementId(Context context, ModelProvider modelProvider) Returns the variable element id, if this is a modeled variable.
protected byte	getFlags()
protected boolean	getFlagValue(byte mask)
String	getName() Returns variable name.
String	getType() Returns the type.
Value	getValue() Returns variable value.
boolean	isExpressionLocal() Returns true is the variable is defined in an expression.
abstract boolean	isInitialValueChanged() Returns true if initial value was changed.
boolean	isInternal() Returns true if this variable is internal.
abstract boolean	isReadOnly() Returns true if variable is read only.
protected void	refreshDirectReferences(ModelInstance modelInstance)
protected void	setFlagValue(boolean b, byte mask)
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
abstract SVariable	toSerializable(SModelInstance smi, MarshallerConfig config) Creates a serializable object.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

protected Value value

Constructor Detail

Variable

protected Variable(String name,
                   String type,
                   byte flags,
                   Value value)

Variable

public Variable(String name,
                String type)

Creates new instance of Variable.

Parameters:

name -

type -

Throws:

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

Variable

public Variable(String name,
                String type,
                Value value)

Creates new instance of Variable.

Parameters:

name -

type -

value -

Throws:

NullPointerException - if context or name or value

Variable

protected Variable(SVariable source,
                   ModelInstance modelInstance)

Method Detail

toSerializable

public abstract SVariable toSerializable(SModelInstance smi,
                                         MarshallerConfig config)

Creates a serializable object.

Parameters:

smi -

config -

Returns:

the created serializable object

fillSerializable

protected void fillSerializable(SVariable s,
                                SModelInstance smi,
                                MarshallerConfig config)

getName

public String getName()

Returns variable name.

Returns:

variable name

getType

public String getType()

Returns the type.

Returns:

the type

getFlags

protected byte getFlags()

getCompiledType

public abstract Type getCompiledType(Context context,
                                     ModelProvider modelProvider)

Returns the compiled type.

Parameters:

context -

modelProvider -

Returns:

the compiled type

getCachedCompiledType

public abstract Type getCachedCompiledType()

Returns the cached compiled type, if it is stored.

Returns:

the cached compiled type or null

compileType

protected Type compileType(Context context,
                           ModelProvider modelProvider)

getValue

public Value getValue()

Returns variable value.

Returns:

variable value

getElementId

public String getElementId(Context context,
                           ModelProvider modelProvider)

Returns the variable element id, if this is a modeled variable.

Parameters:

context -

modelProvider -

Returns:

the element id or null

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 -

isInitialValueChanged

public abstract boolean isInitialValueChanged()

Returns true if initial value was changed.

Returns:

true if initial value was changed

isReadOnly

public abstract 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

getFlagValue

protected final boolean getFlagValue(byte mask)

setFlagValue

protected final void setFlagValue(boolean b,
                                  byte mask)

convertToDirectReferences

public void convertToDirectReferences()

Converts the value to a direct reference.

refreshDirectReferences

protected void refreshDirectReferences(ModelInstance modelInstance)