org.expressionj.model

Class Structure

java.lang.Object

org.expressionj.model.AbstractExpression

org.expressionj.model.AbstractValue

org.expressionj.model.Variable

org.expressionj.model.Structure

All Implemented Interfaces:

java.lang.Cloneable, Equation, Expression, ExpressionType, Value

public class Structure
extends Variable

Represent an instance of a Structure.

Since:

0.9.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Structure.Field Represent a structure field.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<Structure.Field>	fields

Fields inherited from class org.expressionj.model.AbstractValue

name, struct, type, value

Fields inherited from class org.expressionj.model.AbstractExpression

block, root

Fields inherited from interface org.expressionj.model.ExpressionType

STRUCT_ARRAY, STRUCT_SCALAR, STRUCT_STRUCTURE, TYPE_BOOL, TYPE_DYNAMIC, TYPE_FLOAT, TYPE_INTEGER, TYPE_NUMERIC, TYPE_STRING, TYPE_UNDEF

Constructor Summary

Constructors

Constructor and Description
Structure(java.lang.String name) Constructor.
Structure(java.lang.String name, short type) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addField(Structure.Field field) Add a field for this structure.
java.lang.Object	clone()
java.lang.String	getExpressionName() Return the structure name.
java.util.Set<Structure.Field>	getFields() Return the structure fields.
short	getResultStructure() Return the structure of the result for the expression.
short	getResultType() Return the type of the Variable.
void	setValue(java.lang.String varName, java.lang.Object value) Do nothing.

Methods inherited from class org.expressionj.model.Variable

equals, getVariable, getVariables, hashCode, isLocal

Methods inherited from class org.expressionj.model.AbstractValue

checkType, eval, evalAsBoolean, evalAsFloat, evalAsInt, getExpression, getName, getStructure, getType, getValue, getValueAsBoolean, getValueAsFloat, getValueAsInt, initType, setDefaultValue, setName, setStructure, setType, setType, setValue, setValueAsBoolean, setValueAsFloat, setValueAsInt

Methods inherited from class org.expressionj.model.AbstractExpression

getParentBlock, getRoot, setParentBlock, setRoot

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.expressionj.model.Expression

getLocalVariable, getLocalVariables, getParentBlock, getRoot, getVariable, getVariables, hasVariable, hasVariable, removeVariable, setParentBlock

Field Detail

fields

protected java.util.Set<Structure.Field> fields

Constructor Detail

Structure

public Structure(java.lang.String name)

Constructor.

Parameters:

name - the structure name

Structure

public Structure(java.lang.String name,
                 short type)

Constructor.

Parameters:

name - the structure name

type - the structure type

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Specified by:

clone in interface Expression

Overrides:

clone in class Variable

Throws:

java.lang.CloneNotSupportedException

addField

public void addField(Structure.Field field)

Add a field for this structure.

Parameters:

field - the field

getFields

public java.util.Set<Structure.Field> getFields()

Return the structure fields.

Returns:

the fields

getExpressionName

public java.lang.String getExpressionName()

Return the structure name.

Specified by:

getExpressionName in interface Expression

Overrides:

getExpressionName in class Variable

Returns:

the structure name

getResultType

public short getResultType()

Description copied from class: Variable

Return the type of the Variable.

Specified by:

getResultType in interface Expression

Overrides:

getResultType in class Variable

Returns:

the type of the Variable

getResultStructure

public short getResultStructure()

Description copied from interface: Expression

Return the structure of the result for the expression. The structure can be:

• ExpressionType.STRUCT_SCALAR: a scalar value
• ExpressionType.STRUCT_ARRAY: an array value

Specified by:

getResultStructure in interface Expression

Overrides:

getResultStructure in class Variable

Returns:

he structure of the result for the expression

setValue

public void setValue(java.lang.String varName,
                     java.lang.Object value)

Do nothing.

Specified by:

setValue in interface Equation

Overrides:

setValue in class Variable

Parameters:

varName - the variable name

value - the variable value