org.da.protoframework.model.types

Class StructType

java.lang.Object

org.da.protoframework.model.types.Type

org.da.protoframework.model.types.StructType

All Implemented Interfaces:

org.da.protoframework.model.def.DescriptedElement, NamespaceElement

public class StructType
extends Type

Represent structure types.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.da.protoframework.model.types.Type

ANY, BOOL, BYTE, CHAR, DOUBLE, FLOAT, INT, LONG, NIL, SHORT, STRING, UNDEF, URL, XML

Constructor Summary

Constructors

Constructor and Description
StructType(NamespaceKey key) Constructor.
StructType(java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addField(StructType.Field field) Add a field.
boolean	areEqual(java.lang.Object value1, java.lang.Object value2) Return true if two values are considered as equal for this type.
void	clearFields() Clear the fields of the structure.
java.util.List<java.lang.Object>	copyValue(java.lang.Object value) Copy the current value and return it.
int	countFields() Return the number of fields.
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.Object>	getDefaultValue() Return the default structure for this structure type.
StructType	getExtendedType() Return the type that this type extends.
StructType.Field	getField(int position) Return the field at a specified position.
StructType.Field	getField(java.lang.String name) Return the field of a specified name.
int	getFieldPosition(java.lang.String name) Return the position of a specified field.
java.util.Map<java.lang.String,StructType.Field>	getFields() Return the fields sorted by their name.
java.util.List<StructType.Field>	getFieldsList() Return the list of fields.
java.lang.Object	getFieldValue(java.lang.String field, java.lang.Object value) Return the value of a field.
java.util.List<java.lang.Object>	getFieldValueAsArray(java.lang.String field, java.lang.Object value) Return the value of a field as an array.
boolean	getFieldValueAsBoolean(java.lang.String field, java.lang.Object value) Return the value of a field as a boolean.
char	getFieldValueAsChar(java.lang.String field, java.lang.Object value) Return the value of a field as a char.
Data<?>	getFieldValueAsData(java.lang.String field, java.lang.Object value) Return the value of a field as a Data.
double	getFieldValueAsDouble(java.lang.String field, java.lang.Object value) Return the value of a field as a double.
double	getFieldValueAsDouble(java.lang.String field, java.lang.Object value, short unit) Return the value of a field as a double, in a specified unit.
float	getFieldValueAsFloat(java.lang.String field, java.lang.Object value) Return the value of a field as a float.
float	getFieldValueAsFloat(java.lang.String field, java.lang.Object value, short unit) Return the value of a field as a float, in a specified unit.
int	getFieldValueAsInt(java.lang.String field, java.lang.Object value) Return the value of a field as an int.
long	getFieldValueAsLong(java.lang.String field, java.lang.Object value) Return the value of a field as an long.
long	getFieldValueAsLong(java.lang.String field, java.lang.Object value, short unit) Return the value of a field as an long.
short	getFieldValueAsShort(java.lang.String field, java.lang.Object value) Return the value of a field as a short.
java.lang.String	getFieldValueAsString(java.lang.String field, java.lang.Object value) Return the value of a field as a String.
java.util.List<java.lang.Object>	getFieldValueAsStructure(java.lang.String field, java.lang.Object value) Return the value of a field as an array.
java.net.URL	getFieldValueAsURL(java.lang.String field, java.lang.Object value) Return the value of a field as an URL.
java.lang.Object	getInstanceFromValue(java.lang.Object value, java.lang.Class<?> clazz) Set the value of a structure of the specified type from the fields as an instance object.
java.util.List<java.lang.Object>	getNonEmptyDefaultValue() Return a non empty type default value.
Data.Structure	getValueAsData(java.lang.Object value) Return a value as a Data.
java.lang.String	getValueAsString(java.lang.Object value) Return a value as a String.
java.util.List<java.lang.Object>	getValueFromInstance(java.lang.Object instance) Return the value of a structure of the specified type from the fields of an instance object.
static StructType	getVoid() Return an empty Structure type, which contains no field.
boolean	hasField(java.lang.String name) Return true if the Structure has a field of a specified name.
int	hashCode()
boolean	isAbstract() Return true if the type is abstract.
boolean	isSupportingValue(java.lang.Object value) Return true if the specified value is supported.
void	lockDefinition() Lock the fields definition of this type.
void	setAbstract(boolean isAbstract) Set if the type is abstract.
void	setExtendedType(StructType type) Set the type that this type extends.
boolean	setFieldValue(java.lang.String field, java.lang.Object values, java.lang.Object value) Set the value of a field.
boolean	setFieldValueAsBoolean(java.lang.String field, java.lang.Object values, boolean value) Set the value of a field.
boolean	setFieldValueAsChar(java.lang.String field, java.lang.Object values, char value) Set the value of a field as a char.
boolean	setFieldValueAsDouble(java.lang.String field, java.lang.Object values, double value) Set the value of a field as a double.
boolean	setFieldValueAsDouble(java.lang.String field, java.lang.Object values, double value, short unit) Set the value of a field as a double, with a specified unit.
boolean	setFieldValueAsFile(java.lang.String field, java.lang.Object values, java.io.File value) Set the value of a field as a File.
boolean	setFieldValueAsFloat(java.lang.String field, java.lang.Object values, float value) Set the value of a field as a float.
boolean	setFieldValueAsFloat(java.lang.String field, java.lang.Object values, float value, short unit) Set the value of a field as a float, with a specified unit.
boolean	setFieldValueAsInt(java.lang.String field, java.lang.Object values, int value) Set the value of a field as an int.
boolean	setFieldValueAsLong(java.lang.String field, java.lang.Object values, long value) Set the value of a field as a long.
boolean	setFieldValueAsShort(java.lang.String field, java.lang.Object values, short value) Set the value of a field as a short.
boolean	setFieldValueAsString(java.lang.String field, java.lang.Object values, java.lang.String value) Set the value of a field as a String.
boolean	setFieldValueAsURL(java.lang.String field, java.lang.Object values, java.net.URL value) Set the value of a field as an URL.

Methods inherited from class org.da.protoframework.model.types.Type

createData, getDefaultValue, getDescription, getKey, getName, getNamespace, getNamespaceAsString, getTerminalType, getUnit, getValueAsBoolean, getValueAsByte, getValueAsChar, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFloat, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, getValueAsShort, setDescription, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.da.protoframework.model.namespace.NamespaceElement

getFullName

Methods inherited from interface org.da.protoframework.model.def.DescriptedElement

hasDescription

Constructor Detail

StructType

public StructType(java.lang.String name)

Constructor.

Parameters:

name - the type name

StructType

public StructType(NamespaceKey key)

Constructor.

Parameters:

key - the type key

Method Detail

getVoid

public static StructType getVoid()

Return an empty Structure type, which contains no field.

Returns:

the empty Structure type

setAbstract

public void setAbstract(boolean isAbstract)

Set if the type is abstract.

Parameters:

isAbstract - true if the type is abstract

isAbstract

public boolean isAbstract()

Return true if the type is abstract.

Overrides:

isAbstract in class Type

Returns:

true if the type is abstract

setExtendedType

public void setExtendedType(StructType type)

Set the type that this type extends.

Parameters:

type - the type

getExtendedType

public StructType getExtendedType()

Return the type that this type extends. If this type does not extend any other type, then the method will return null.

Overrides:

getExtendedType in class Type

Returns:

the type

isSupportingValue

public boolean isSupportingValue(java.lang.Object value)

Return true if the specified value is supported.

Specified by:

isSupportingValue in class Type

Parameters:

value - the value

Returns:

true if the specified value is supported

getDefaultValue

public java.util.List<java.lang.Object> getDefaultValue()

Return the default structure for this structure type.

Specified by:

getDefaultValue in class Type

Returns:

the default structure for this structure type

getNonEmptyDefaultValue

public java.util.List<java.lang.Object> getNonEmptyDefaultValue()

Return a non empty type default value.

Overrides:

getNonEmptyDefaultValue in class Type

Returns:

a non empty type default value

areEqual

public boolean areEqual(java.lang.Object value1,
                        java.lang.Object value2)

Return true if two values are considered as equal for this type.

Specified by:

areEqual in class Type

Parameters:

value1 - the first value

value2 - the second value

Returns:

true if the two values are conbsidered equal

copyValue

public java.util.List<java.lang.Object> copyValue(java.lang.Object value)

Copy the current value and return it.

Overrides:

copyValue in class Type

Parameters:

value - the value to copy

Returns:

the copied value

getValueAsData

public Data.Structure getValueAsData(java.lang.Object value)

Return a value as a Data.

Overrides:

getValueAsData in class Type

Parameters:

value - the value

Returns:

the value as a Data

getValueAsString

public java.lang.String getValueAsString(java.lang.Object value)

Return a value as a String.

Specified by:

getValueAsString in class Type

Parameters:

value - the value

Returns:

the value as a String

lockDefinition

public void lockDefinition()

Lock the fields definition of this type.

clearFields

public void clearFields()

Clear the fields of the structure. Note that it will no nothing for the client modules, as this is reserved for the configuration stage of the framework.

getFieldsList

public java.util.List<StructType.Field> getFieldsList()

Return the list of fields.

Returns:

the list of fields

countFields

public int countFields()

Return the number of fields.

Returns:

the number of fields

hasField

public boolean hasField(java.lang.String name)

Return true if the Structure has a field of a specified name.

Parameters:

name - the field name

Returns:

true if the Structure has a field of the specified name

getFields

public java.util.Map<java.lang.String,StructType.Field> getFields()

Return the fields sorted by their name.

Returns:

the fields

getField

public StructType.Field getField(int position)

Return the field at a specified position.

Parameters:

position - the field position

Returns:

the field

getField

public StructType.Field getField(java.lang.String name)

Return the field of a specified name.

Parameters:

name - the field name

Returns:

the field

getFieldPosition

public int getFieldPosition(java.lang.String name)

Return the position of a specified field.

Parameters:

name - the field name

Returns:

the field position

addField

public void addField(StructType.Field field)

Add a field.

Parameters:

field - the field

getValueFromInstance

public java.util.List<java.lang.Object> getValueFromInstance(java.lang.Object instance)

Return the value of a structure of the specified type from the fields of an instance object.

Specified by:

getValueFromInstance in class Type

Parameters:

instance - the instance object

Returns:

the value of a structure of the specified type

getInstanceFromValue

public java.lang.Object getInstanceFromValue(java.lang.Object value,
                                             java.lang.Class<?> clazz)

Set the value of a structure of the specified type from the fields as an instance object.

Specified by:

getInstanceFromValue in class Type

Parameters:

value - the structure value

clazz - the Class

Returns:

the value of a structure as an instance of the Class

setFieldValue

public boolean setFieldValue(java.lang.String field,
                             java.lang.Object values,
                             java.lang.Object value)

Set the value of a field.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set.

Returns:

true if the value was modified

setFieldValueAsBoolean

public boolean setFieldValueAsBoolean(java.lang.String field,
                                      java.lang.Object values,
                                      boolean value)

Set the value of a field.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsInt

public boolean setFieldValueAsInt(java.lang.String field,
                                  java.lang.Object values,
                                  int value)

Set the value of a field as an int.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsLong

public boolean setFieldValueAsLong(java.lang.String field,
                                   java.lang.Object values,
                                   long value)

Set the value of a field as a long.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsChar

public boolean setFieldValueAsChar(java.lang.String field,
                                   java.lang.Object values,
                                   char value)

Set the value of a field as a char.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsShort

public boolean setFieldValueAsShort(java.lang.String field,
                                    java.lang.Object values,
                                    short value)

Set the value of a field as a short.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsFloat

public boolean setFieldValueAsFloat(java.lang.String field,
                                    java.lang.Object values,
                                    float value,
                                    short unit)

Set the value of a field as a float, with a specified unit.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

unit - the unit

Returns:

true if the value was modified

setFieldValueAsFloat

public boolean setFieldValueAsFloat(java.lang.String field,
                                    java.lang.Object values,
                                    float value)

Set the value of a field as a float.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsDouble

public boolean setFieldValueAsDouble(java.lang.String field,
                                     java.lang.Object values,
                                     double value,
                                     short unit)

Set the value of a field as a double, with a specified unit.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

unit - the unit

Returns:

true if the value was modified

setFieldValueAsDouble

public boolean setFieldValueAsDouble(java.lang.String field,
                                     java.lang.Object values,
                                     double value)

Set the value of a field as a double.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsString

public boolean setFieldValueAsString(java.lang.String field,
                                     java.lang.Object values,
                                     java.lang.String value)

Set the value of a field as a String.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsFile

public boolean setFieldValueAsFile(java.lang.String field,
                                   java.lang.Object values,
                                   java.io.File value)

Set the value of a field as a File.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

setFieldValueAsURL

public boolean setFieldValueAsURL(java.lang.String field,
                                  java.lang.Object values,
                                  java.net.URL value)

Set the value of a field as an URL.

Parameters:

field - the field

values - the structure value. Note that this must be a List, the method will return false if this is not a List.

value - the field value to set

Returns:

true if the value was modified

getFieldValueAsBoolean

public boolean getFieldValueAsBoolean(java.lang.String field,
                                      java.lang.Object value)

Return the value of a field as a boolean.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return false if this is not a List.

Returns:

the field value as a boolean

getFieldValueAsInt

public int getFieldValueAsInt(java.lang.String field,
                              java.lang.Object value)

Return the value of a field as an int.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

Returns:

the field value as an int

getFieldValueAsLong

public long getFieldValueAsLong(java.lang.String field,
                                java.lang.Object value)

Return the value of a field as an long.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

Returns:

the field value as an long

getFieldValueAsLong

public long getFieldValueAsLong(java.lang.String field,
                                java.lang.Object value,
                                short unit)

Return the value of a field as an long.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

Returns:

the field value as an long

getFieldValueAsChar

public char getFieldValueAsChar(java.lang.String field,
                                java.lang.Object value)

Return the value of a field as a char.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

Returns:

the field value as a short

getFieldValueAsShort

public short getFieldValueAsShort(java.lang.String field,
                                  java.lang.Object value)

Return the value of a field as a short.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

Returns:

the field value as a short

getFieldValueAsFloat

public float getFieldValueAsFloat(java.lang.String field,
                                  java.lang.Object value)

Return the value of a field as a float.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

Returns:

the field value as a float

getFieldValueAsFloat

public float getFieldValueAsFloat(java.lang.String field,
                                  java.lang.Object value,
                                  short unit)

Return the value of a field as a float, in a specified unit.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

unit - the unit

Returns:

the field value as a float

getFieldValueAsDouble

public double getFieldValueAsDouble(java.lang.String field,
                                    java.lang.Object value)

Return the value of a field as a double.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

Returns:

the field value as a double

getFieldValueAsDouble

public double getFieldValueAsDouble(java.lang.String field,
                                    java.lang.Object value,
                                    short unit)

Return the value of a field as a double, in a specified unit.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return 0 if this is not a List.

unit - the unit

Returns:

the field value as a double

getFieldValueAsString

public java.lang.String getFieldValueAsString(java.lang.String field,
                                              java.lang.Object value)

Return the value of a field as a String.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return an empty String if this is not a List.

Returns:

the field value as a String

getFieldValueAsURL

public java.net.URL getFieldValueAsURL(java.lang.String field,
                                       java.lang.Object value)

Return the value of a field as an URL.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return an empty String if this is not a List.

Returns:

the field value as an URL

getFieldValueAsArray

public java.util.List<java.lang.Object> getFieldValueAsArray(java.lang.String field,
                                                             java.lang.Object value)

Return the value of a field as an array.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return an empty String if this is not a List.

Returns:

the field value as a String

getFieldValueAsStructure

public java.util.List<java.lang.Object> getFieldValueAsStructure(java.lang.String field,
                                                                 java.lang.Object value)

Return the value of a field as an array.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return an empty String if this is not a List.

Returns:

the field value as a String

getFieldValueAsData

public Data<?> getFieldValueAsData(java.lang.String field,
                                   java.lang.Object value)

Return the value of a field as a Data.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return null if this is not a List.

Returns:

the Data

getFieldValue

public java.lang.Object getFieldValue(java.lang.String field,
                                      java.lang.Object value)

Return the value of a field.

Parameters:

field - the field

value - the structure value. Note that this must be a List, the method will return null if this is not a List.

Returns:

the field value

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object