|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A representation of the model object 'Extended Data Element'.
The ExtendedDataElement allows for application-supplied name-type-value collections to be specified for extensibility purposes. This is the mechanism by which other attributes not specified in the CommonBaseEvent data model can be added. Collections specified here are assumed to be product specific data.
The named properties can be filtered, searched or referenced by the correlation rules. The name is user defined, however, the nonexclusive reserved keywords are as follows:
The following features are supported:
- {@link org.eclipse.hyades.logging.events.cbe.ExtendedDataElement#getHexValue Hex Value}
- {@link org.eclipse.hyades.logging.events.cbe.ExtendedDataElement#getName Name}
- {@link org.eclipse.hyades.logging.events.cbe.ExtendedDataElement#getType Type}
- {@link org.eclipse.hyades.logging.events.cbe.ExtendedDataElement#getValues Values}
- {@link org.eclipse.hyades.logging.events.cbe.ExtendedDataElement#getChildren Children}
,
EventPackage.getExtendedDataElement()
Field Summary | |
---|---|
static java.lang.String |
TYPE_BOOLEAN
Indicates a boolean value for the extended data element. |
static java.lang.String |
TYPE_BOOLEAN_ARRAY
Indicates an array of boolean values for the extended data element. |
static int |
TYPE_BOOLEAN_ARRAY_VALUE
Indicates an array of boolean values for the extended data element. |
static int |
TYPE_BOOLEAN_VALUE
Indicates a boolean value for the extended data element. |
static java.lang.String |
TYPE_BYTE
Indicates a byte value for the extended data element. |
static java.lang.String |
TYPE_BYTE_ARRAY
Indicates an array of byte values for the extended data element. |
static int |
TYPE_BYTE_ARRAY_VALUE
Indicates an array of byte values for the extended data element. |
static int |
TYPE_BYTE_VALUE
Indicates a byte value for the extended data element. |
static java.lang.String |
TYPE_DATE_TIME
Indicates a date time value for the extended data element. |
static java.lang.String |
TYPE_DATE_TIME_ARRAY
Indicates an array of date time values for the extended data element. |
static int |
TYPE_DATE_TIME_ARRAY_VALUE
Indicates an array of date time values for the extended data element. |
static int |
TYPE_DATE_TIME_VALUE
Indicates a date time value for the extended data element. |
static java.lang.String |
TYPE_DOUBLE
Indicates a double value for the extended data element. |
static java.lang.String |
TYPE_DOUBLE_ARRAY
Indicates an array of double values for the extended data element. |
static int |
TYPE_DOUBLE_ARRAY_VALUE
Indicates an array of double values for the extended data element. |
static int |
TYPE_DOUBLE_VALUE
Indicates a double value for the extended data element. |
static java.lang.String |
TYPE_FLOAT
Indicates a float value for the extended data element. |
static java.lang.String |
TYPE_FLOAT_ARRAY
Indicates an array of float values for the extended data element. |
static int |
TYPE_FLOAT_ARRAY_VALUE
Indicates an array of float values for the extended data element. |
static int |
TYPE_FLOAT_VALUE
Indicates a float value for the extended data element. |
static java.lang.String |
TYPE_HEX_BINARY
Indicates an hex binary value for the extended data element. |
static int |
TYPE_HEX_BINARY_VALUE
Indicates an hex binary value for the extended data element. |
static java.lang.String |
TYPE_INT
Indicates an integer value for the extended data element. |
static java.lang.String |
TYPE_INT_ARRAY
Indicates an array of integer values for the extended data element. |
static int |
TYPE_INT_ARRAY_VALUE
Indicates an array of integer values for the extended data element. |
static int |
TYPE_INT_VALUE
Indicates an integer value for the extended data element. |
static java.lang.String |
TYPE_LONG
Indicates a long value for the extended data element. |
static java.lang.String |
TYPE_LONG_ARRAY
Indicates an array of long values for the extended data element. |
static int |
TYPE_LONG_ARRAY_VALUE
Indicates an array of long values for the extended data element. |
static int |
TYPE_LONG_VALUE
Indicates a long value for the extended data element. |
static java.lang.String |
TYPE_NO_VALUE
Indicates that type for an extended data element that does not have a value. |
static int |
TYPE_NO_VALUE_VALUE
Indicates that type for an extended data element that does not have a value. |
static java.lang.String |
TYPE_SHORT
Indicates a short value for the extended data element. |
static java.lang.String |
TYPE_SHORT_ARRAY
Indicates an array of short values for the extended data element. |
static int |
TYPE_SHORT_ARRAY_VALUE
Indicates an array of short values for the extended data element. |
static int |
TYPE_SHORT_VALUE
Indicates a short value for the extended data element. |
static java.lang.String |
TYPE_STRING
Indicates a string value for the extended data element. |
static java.lang.String |
TYPE_STRING_ARRAY
Indicates an array of string values for the extended data element. |
static int |
TYPE_STRING_ARRAY_VALUE
Indicates an array of string values for the extended data element. |
static int |
TYPE_STRING_VALUE
Indicates a string value for the extended data element. |
Method Summary | |
---|---|
ExtendedDataElement |
addChild(ExtendedDataElement child)
Adds a new child ExtendedDataElement to this object. |
ExtendedDataElement |
addChild(java.lang.String name)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChild(java.lang.String name,
int type,
java.lang.String value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChild(java.lang.String name,
int type,
java.lang.String[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChild(java.lang.String name,
java.lang.String value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChild(java.lang.String name,
java.lang.String[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithBooleanArrayValue(java.lang.String name,
boolean[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithBooleanValue(java.lang.String name,
boolean value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithByteArrayValue(java.lang.String name,
byte[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithByteValue(java.lang.String name,
byte value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithDateArrayValue(java.lang.String name,
java.lang.String[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithDateAsLongValue(java.lang.String name,
long value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithDatesAsLongValue(java.lang.String name,
long[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithDateValue(java.lang.String name,
java.lang.String value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithDoubleArrayValue(java.lang.String name,
double[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithDoubleValue(java.lang.String name,
double value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithFloatArrayValue(java.lang.String name,
float[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithFloatValue(java.lang.String name,
float value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithHexValue(java.lang.String name,
java.lang.String value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithHexValueAsByteArray(java.lang.String name,
byte[] value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithIntArrayValue(java.lang.String name,
int[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithIntValue(java.lang.String name,
int value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithLongArrayValue(java.lang.String name,
long[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithLongValue(java.lang.String name,
long value)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithShortArrayValue(java.lang.String name,
short[] values)
Adds a new ExtendedDataElement to this object. |
ExtendedDataElement |
addChildWithShortValue(java.lang.String name,
short value)
Adds a new ExtendedDataElement to this object. |
void |
clearChildren()
Removes all child ExtenedDataElements that this event is referencing |
void |
clearValues()
Removes all values that this event is referencing |
org.eclipse.emf.common.util.EList |
getChildren()
Returns the value of the 'Children' containment reference list. |
org.eclipse.emf.common.util.EList |
getChildren(java.lang.String name)
Helper method to return a named child ExtendedDataElement
from the list of children ExtendedDataElement s. |
java.lang.String |
getHexValue()
Returns the value of the 'Hex Value' attribute. |
byte[] |
getHexValueAsByteArray()
Returns the hexValue of the extended data element cast as byte array values. |
char[] |
getHexValueAsCharArray()
Returns the hexValue of the extended data element cast as char array values. |
java.lang.String |
getName()
Returns the value of the 'Name' attribute. |
java.lang.String |
getType()
Returns the value of the 'Type' attribute. |
int |
getTypeAsInt()
Returns the value of the 'Type' attribute. |
org.eclipse.emf.common.util.EList |
getValues()
Returns the value of the 'Values' attribute list. |
boolean |
getValuesAsBoolean()
Returns the value of the extended data element cast as a boolean value. |
boolean[] |
getValuesAsBooleanArray()
Returns the values of the extended data element cast as boolean values. |
byte |
getValuesAsByte()
Returns the value of the extended data element cast as a byte value. |
byte[] |
getValuesAsByteArray()
Returns the values of the extended data element cast as byte values. |
java.lang.String |
getValuesAsDate()
Returns the value of the extended data element cast as a date/time value. |
java.lang.String[] |
getValuesAsDateArray()
Returns the value of the extended data element cast as a date/time values. |
long |
getValuesAsDateAsLong()
Returns the value of the extended data element cast as a date/time value. |
long[] |
getValuesAsDateAsLongArray()
Returns the values of the extended data element cast as date/time values. |
double |
getValuesAsDouble()
Returns the value of the extended data element cast as a double value. |
double[] |
getValuesAsDoubleArray()
Returns the values of the extended data element cast as double values. |
float |
getValuesAsFloat()
Returns the value of the extended data element cast as a float value. |
float[] |
getValuesAsFloatArray()
Returns the values of the extended data element cast as float values. |
int |
getValuesAsInt()
Returns the value of the extended data element cast as an integer value. |
int[] |
getValuesAsIntArray()
Returns the values of the extended data element cast as integer values. |
long |
getValuesAsLong()
Returns the value of the extended data element cast as a long value. |
long[] |
getValuesAsLongArray()
Returns the values of the extended data element cast as long values. |
short |
getValuesAsShort()
Returns the value of the extended data element cast as a short value. |
short[] |
getValuesAsShortArray()
Returns the values of the extended data element cast as short values. |
java.lang.String |
getValuesAsString()
Returns the value of the extended data element cast as a string value. |
java.lang.String[] |
getValuesAsStringArray()
Returns the values of the extended data element cast as string values. |
void |
init()
Resets the object's properties to their initial (e.g. |
void |
removeChildren(java.lang.String name)
Remove a named child extended data element that this event is referencing |
void |
setHexValue(java.lang.String value)
Sets the value of the ' Hex Value ' attribute. |
void |
setHexValueAsByteArray(byte[] value)
Sets the hexValue of the extended data element as an array of bytes. |
void |
setHexValueAsCharArray(char[] value)
Sets the hexValue of the extended data element as an array of chars. |
void |
setName(java.lang.String value)
Sets the value of the ' Name ' attribute. |
void |
setType(java.lang.String value)
Sets the value of the ' Type ' attribute. |
void |
setTypeAsInt(int value)
Sets the value of the ' Type ' attribute. |
void |
setValues(java.lang.String[] values)
The array of values for this extended data element as a string representation of the type specified above, excluding hexBinary. |
void |
setValuesAsBoolean(boolean value)
Sets the value of the extended data element as a boolean value. |
void |
setValuesAsBooleanArray(boolean[] value)
Sets the value of the extended data element as an array of boolean values. |
void |
setValuesAsByte(byte value)
Sets the value of the extended data element as a byte value. |
void |
setValuesAsByteArray(byte[] value)
Sets the value of the extended data element as an array of bytes. |
void |
setValuesAsDate(java.lang.String value)
Sets the value of the extended data element as a date time value. |
void |
setValuesAsDateArray(java.lang.String[] value)
Sets the value of the extended data element as an array of date time values. |
void |
setValuesAsDateAsLong(long value)
Sets the value of the extended data element as a date/time value. |
void |
setValuesAsDateAsLongArray(long[] values)
Sets the value of the extended data element as an array of date/time values. |
void |
setValuesAsDouble(double value)
Sets the value of the extended data element as a double value. |
void |
setValuesAsDoubleArray(double[] value)
Sets the value of the extended data element as an array of double values. |
void |
setValuesAsFloat(float value)
Sets the value of the extended data element as a float value. |
void |
setValuesAsFloatArray(float[] value)
Sets the value of the extended data element as an array of float values. |
void |
setValuesAsInt(int value)
Sets the value of the extended data element as a int value. |
void |
setValuesAsIntArray(int[] value)
Sets the value of the extended data element as an array of integer values. |
void |
setValuesAsLong(long value)
Sets the value of the extended data element as a long value. |
void |
setValuesAsLongArray(long[] value)
Sets the value of the extended data element as an array of long values. |
void |
setValuesAsShort(short value)
Sets the value of the extended data element as a short value. |
void |
setValuesAsShortArray(short[] value)
Sets the value of the extended data element as an array of short values. |
void |
setValuesAsString(java.lang.String value)
Sets the value of the extended data element as a string value. |
void |
setValuesAsStringArray(java.lang.String[] value)
Sets the value of the extended data element as an array of string values. |
void |
validate()
Checks whether the contents of this object conforms to the CBE specification. |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Field Detail |
public static final java.lang.String TYPE_NO_VALUE
getType()
,
Constant Field Valuespublic static final int TYPE_NO_VALUE_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_BYTE
getType()
,
Constant Field Valuespublic static final int TYPE_BYTE_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_SHORT
getType()
,
Constant Field Valuespublic static final int TYPE_SHORT_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_INT
getType()
,
Constant Field Valuespublic static final int TYPE_INT_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_LONG
getType()
,
Constant Field Valuespublic static final int TYPE_LONG_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_FLOAT
getType()
,
Constant Field Valuespublic static final int TYPE_FLOAT_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_DOUBLE
getType()
,
Constant Field Valuespublic static final int TYPE_DOUBLE_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_STRING
getType()
,
Constant Field Valuespublic static final int TYPE_STRING_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_DATE_TIME
getType()
,
Constant Field Valuespublic static final int TYPE_DATE_TIME_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_BOOLEAN
getType()
,
Constant Field Valuespublic static final int TYPE_BOOLEAN_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_BYTE_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_BYTE_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_SHORT_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_SHORT_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_INT_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_INT_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_LONG_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_LONG_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_FLOAT_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_FLOAT_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_DOUBLE_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_DOUBLE_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_STRING_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_STRING_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_DATE_TIME_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_DATE_TIME_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_BOOLEAN_ARRAY
getType()
,
Constant Field Valuespublic static final int TYPE_BOOLEAN_ARRAY_VALUE
getType()
,
Constant Field Valuespublic static final java.lang.String TYPE_HEX_BINARY
getType()
,
Constant Field Valuespublic static final int TYPE_HEX_BINARY_VALUE
getType()
,
Constant Field ValuesMethod Detail |
public org.eclipse.emf.common.util.EList getChildren(java.lang.String name)
Helper method to return a named child ExtendedDataElement
from the list of children ExtendedDataElement
s.
name
- the name of the child ExtendedDataElement
ExtendedDataElement
objects.public org.eclipse.emf.common.util.EList getChildren()
ExtendedDataElement
.
Contains other extendedDataElements to specify a structured list of extendedDataElements. This list allows a reporter to create a hierarchy of extendedDataElements for a specific CommonBaseEvent. This is an optional property.
Important: This method is automatically generated and returns
an EList
, which inherits from
List
EventPackage.getExtendedDataElement_Children()
public void setHexValue(java.lang.String value)
Hex Value
' attribute.
The hexValue is an array of characters that holds the data for any other data type or complexType not in the supported types described above. The hexValue and the values properties are mutually exclusive. Only one of these properties shall be defined. This is an optional property.
The value is represented according to the XML schema hexBinary definition.
value
- the new value of the 'Hex Value' attribute.getHexValue()
public java.lang.String getHexValue()
The value is represented according to the XML schema hexBinary definition.
setHexValue(String)
,
EventPackage.getExtendedDataElement_HexValue()
public void setName(java.lang.String value)
Name
' attribute.
The name of the extended data element. This name must be unique with respect to all other fields at the same level of extendedDataElement hierarchy, however, there may exist a child with the same name at different level or hierarchy.
This is a required property. The string length for this property must not exceed 64 characters.
value
- the new value of the 'Name' attribute.getName()
public java.lang.String getName()
Returns the value of the 'Name' attribute.
setName(String)
,
EventPackage.getExtendedDataElement_Name()
public void setType(java.lang.String value)
Type
' attribute.
The data type of the values specified in the values property.
Valid types are as follows:
The default value is "string". This is a required property. The string length for this property must not exceed 64 characters.
value
- the new value of the 'Type' attribute.getType()
public java.lang.String getType()
Returns the value of the 'Type' attribute.
setType(String)
,
EventPackage.getExtendedDataElement_Type()
public void setTypeAsInt(int value)
Type
' attribute.
The value must be one of the
ExtendedDataElement.TYPE_<type>_VALUE
constants.
value
- the new value of the 'Type' attribute.getType()
,
getTypeAsInt()
public int getTypeAsInt()
The value is represented through one of the
ExtendedDataElement.TYPE_<type>_VALUE
constants.
setType(String)
,
setTypeAsInt(int)
,
EventPackage.getExtendedDataElement_Type()
public void clearValues()
public org.eclipse.emf.common.util.EList getValues()
String
.
The array of values for this extended data element represented as a string of the specified type, excluding hexBinary. hexBinary values must be defined using the hexValue property.
The hexValue and the values properties are mutually exclusive. Only one of these properties shall be defined. This is an optional property. The string length for a value must not exceed 1024 characters.
Important: This method is automatically generated and returns
an EList
, which inherits from
List
EventPackage.getExtendedDataElement_Values()
public void setValues(java.lang.String[] values)
InvalidExtendedDataElementTypeException
- if the extended data element is a hexBinary data type.public void setValuesAsByte(byte value)
It also changes the 'Type' attribute to TYPE_BYTE
.
value
- the new value for the extended data element.public void setValuesAsByteArray(byte[] value)
It also changes the 'Type' attribute to TYPE_BYTE_ARRAY
.
value
- the new value for the extended data element.public byte getValuesAsByte()
Returns the value of the extended data element cast as a byte value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_BYTE
.public byte[] getValuesAsByteArray()
Returns the values of the extended data element cast as byte values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_BYTE_ARRAY
.public void setValuesAsBoolean(boolean value)
It also changes the 'Type' attribute to TYPE_BOOLEAN
.
value
- the new value for the extended data element.public void setValuesAsBooleanArray(boolean[] value)
It also changes the 'Type' attribute to TYPE_BOOLEAN_ARRAY
.
value
- the new value for the extended data element.public boolean getValuesAsBoolean()
Returns the value of the extended data element cast as a boolean value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_BOOLEAN
.public boolean[] getValuesAsBooleanArray()
Returns the values of the extended data element cast as boolean values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_BOOLEAN_ARRAY
.public void setValuesAsDate(java.lang.String value)
The values are represented according to the XML schema dateTime definition.
It also changes the 'Type' attribute to TYPE_DATE_TIME
.
value
- the new value for the extended data element.public void setValuesAsDateArray(java.lang.String[] value)
The values are represented according to the XML schema dateTime definition.
It also changes the 'Type' attribute to TYPE_DATE_TIME_ARRAY
.
value
- the new value for the extended data element.public void setValuesAsDateAsLong(long value)
The values are represented according to the XML schema dateTime definition.
It also changes the 'Type' attribute to TYPE_DATE_TIME
.
value
- the new value for the extended data element.public void setValuesAsDateAsLongArray(long[] values)
The values are represented according to the XML schema dateTime definition.
It also changes the 'Type' attribute to TYPE_DATE_TIME_ARRAY
.
values
- the new value for the extended data element.public long getValuesAsDateAsLong()
Returns the value of the extended data element cast as a date/time value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_DATE_TIME
.public java.lang.String getValuesAsDate()
The value is represented according to the XML schema dateTime definition.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_DATE_TIME
.public long[] getValuesAsDateAsLongArray()
Returns the values of the extended data element cast as date/time values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_DATE_TIME_ARRAY
.public java.lang.String[] getValuesAsDateArray()
The values are represented according to the XML schema dateTime definition.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_DATE_TIME_ARRAY
.public void setValuesAsDouble(double value)
It also changes the 'Type' attribute to TYPE_DOUBLE
.
value
- the new value for the extended data element.public void setValuesAsDoubleArray(double[] value)
It also changes the 'Type' attribute to TYPE_DOUBLE_ARRAY
.
value
- the new value for the extended data element.public double getValuesAsDouble()
Returns the value of the extended data element cast as a double value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_DOUBLE
.public double[] getValuesAsDoubleArray()
Returns the values of the extended data element cast as double values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_DOUBLE_ARRAY
.public void setValuesAsFloat(float value)
It also changes the 'Type' attribute to TYPE_FLOAT
.
value
- the new value for the extended data element.public void setValuesAsFloatArray(float[] value)
It also changes the 'Type' attribute to TYPE_FLOAT_ARRAY
.
value
- the new value for the extended data element.public float getValuesAsFloat()
Returns the value of the extended data element cast as a float value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_FLOAT
.public float[] getValuesAsFloatArray()
Returns the values of the extended data element cast as float values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_FLOAT_ARRAY
.public void setValuesAsInt(int value)
It also changes the 'Type' attribute to TYPE_INT
.
value
- the new value for the extended data element.public void setValuesAsIntArray(int[] value)
It also changes the 'Type' attribute to TYPE_INT_ARRAY
.
value
- the new value for the extended data element.public int getValuesAsInt()
Returns the value of the extended data element cast as an integer value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_INT
.public int[] getValuesAsIntArray()
Returns the values of the extended data element cast as integer values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_INT_ARRAY
.public void setValuesAsLong(long value)
It also changes the 'Type' attribute to TYPE_LONG
.
value
- the new value for the extended data element.public void setValuesAsLongArray(long[] value)
It also changes the 'Type' attribute to TYPE_LONG_ARRAY
.
value
- the new value for the extended data element.public long getValuesAsLong()
Returns the value of the extended data element cast as a long value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_LONG
.public long[] getValuesAsLongArray()
Returns the values of the extended data element cast as long values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_LONG_ARRAY
.public void setValuesAsShort(short value)
It also changes the 'Type' attribute to TYPE_SHORT
.
value
- the new value for the extended data element.public void setValuesAsShortArray(short[] value)
It also changes the 'Type' attribute to TYPE_SHORT_ARRAY
.
value
- the new value for the extended data element.public short getValuesAsShort()
Returns the value of the extended data element cast as a short value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_SHORT
.public short[] getValuesAsShortArray()
Returns the values of the extended data element cast as short values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_SHORT_ARRAY
.public void setValuesAsString(java.lang.String value)
It also changes the 'Type' attribute to TYPE_STRING
.
value
- the new value for the extended data element.public void setValuesAsStringArray(java.lang.String[] value)
It also changes the 'Type' attribute to TYPE_STRING_ARRAY
.
value
- the new value for the extended data element.public java.lang.String getValuesAsString()
Returns the value of the extended data element cast as a string value.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_STRING
.public java.lang.String[] getValuesAsStringArray()
Returns the values of the extended data element cast as string values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_STRING_ARRAY
.public byte[] getHexValueAsByteArray()
Returns the hexValue of the extended data element cast as byte array values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_HEX_BINARY
.public char[] getHexValueAsCharArray()
Returns the hexValue of the extended data element cast as char array values.
java.lang.IllegalStateException
- if the 'Type' attribute is
not TYPE_HEX_BINARY
.public void setHexValueAsByteArray(byte[] value)
It also changes the 'Type' attribute to TYPE_HEX_BINARY
.
value
- the new hexValue for the extended data element.public void setHexValueAsCharArray(char[] value)
It also changes the 'Type' attribute to TYPE_HEX_BINARY
.
value
- the new hexValue for the extended data element.public ExtendedDataElement addChild(ExtendedDataElement child)
ExtendedDataElement
to this object.
getChildren()
public void clearChildren()
public void removeChildren(java.lang.String name)
name
- the name of the child element to be removedpublic ExtendedDataElement addChild(java.lang.String name)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object without
any values adds it to the list of extended data elements for this
object.
name
- the name for the new extended data element.
public ExtendedDataElement addChild(java.lang.String name, int type, java.lang.String value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.type
- represents the data type for the new
extended data element. Refer to the
ExtendedDataElement.TYPE_<type>_VALUE
constants for valid types.value
- the value for the new extended data element.
java.lang.IllegalArgumentException
- if the type
parameter is not one
of the constants defined in
ExtendedDataElement.TYPE_<type>_VALUE
public ExtendedDataElement addChild(java.lang.String name, int type, java.lang.String[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.type
- represents the data type for the new
extended data element. Refer to the
ExtendedDataElement.TYPE_<type>_VALUE
constants for valid types.values
- the array of values for the new extended data
element.
java.lang.IllegalArgumentException
- if the type
parameter is not one
of the constants defined in
ExtendedDataElement.TYPE_<type>_VALUE
public ExtendedDataElement addChild(java.lang.String name, java.lang.String value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public ExtendedDataElement addChild(java.lang.String name, java.lang.String[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of String
values for the
new extended data element.
public ExtendedDataElement addChildWithBooleanArrayValue(java.lang.String name, boolean[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of boolean
values for the new
extended data element.
public ExtendedDataElement addChildWithBooleanValue(java.lang.String name, boolean value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public ExtendedDataElement addChildWithByteArrayValue(java.lang.String name, byte[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of byte
values for the new
extended data element.
public ExtendedDataElement addChildWithByteValue(java.lang.String name, byte value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public ExtendedDataElement addChildWithDateArrayValue(java.lang.String name, java.lang.String[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
The values correspond to a date time string according to the XML schema dateTime definition.
name
- the name for the new extended data element.values
- the array of String
instances
representing the date time values for the new
extended data element.
public ExtendedDataElement addChildWithDateAsLongValue(java.lang.String name, long value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- number of milliseconds since January 1, 1970 UTC;
representing the date time value for the new
extended data element.
public ExtendedDataElement addChildWithDateValue(java.lang.String name, java.lang.String value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
The value corresponds to a date time string according to the XML schema dateTime definition.
name
- the name for the new extended data element.value
- representation of the date time value for the new
extended data element.
public ExtendedDataElement addChildWithDatesAsLongValue(java.lang.String name, long[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of long
values for the new
extended data element. Each
value corresponds to the number of milliseconds
since January 1, 1970 UTC.
public ExtendedDataElement addChildWithDoubleArrayValue(java.lang.String name, double[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of double
values for the new
extended data element.
public ExtendedDataElement addChildWithDoubleValue(java.lang.String name, double value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the double
value that the new
ExtendedDataElement
will contain.
public ExtendedDataElement addChildWithFloatArrayValue(java.lang.String name, float[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of float/code> values for the new
extended data element.
- Returns:
- a reference to the extended data element added
to this object.
public ExtendedDataElement addChildWithFloatValue(java.lang.String name, float value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public ExtendedDataElement addChildWithIntArrayValue(java.lang.String name, int[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of int
values for the new
extended data element.
public ExtendedDataElement addChildWithIntValue(java.lang.String name, int value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public ExtendedDataElement addChildWithLongArrayValue(java.lang.String name, long[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of long
values for the new
extended data element.
public ExtendedDataElement addChildWithLongValue(java.lang.String name, long value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public ExtendedDataElement addChildWithShortArrayValue(java.lang.String name, short[] values)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object with the values
passed as parameters and adds it to the list of extended data elements
for this object.
name
- the name for the new extended data element.values
- the array of short
values for the new
extended data element.
public ExtendedDataElement addChildWithShortValue(java.lang.String name, short value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public ExtendedDataElement addChildWithHexValue(java.lang.String name, java.lang.String value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public ExtendedDataElement addChildWithHexValueAsByteArray(java.lang.String name, byte[] value)
ExtendedDataElement
to this object.
It creates an ExtendedDataElement
object containing the
value passed as parameter and adds it to the list of extended data
elements for this object.
name
- the name for the new extended data element.value
- the value for the new extended data element.
public void validate() throws ValidationException
Checks whether the contents of this object conforms to the CBE specification.
ValidationException
- if the object does not follow the CBE
specification.public void init()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |