ExtendedDataElement

Overview

Package

Class

Tree

Deprecated

Index

Help

TPTP 4.5.0 Platform Project
Public API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.tptp.logging.events.cbe
Interface ExtendedDataElement

All Superinterfaces:: java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:: ExtendedDataElementImpl

public interface ExtendedDataElement
extends java.lang.Cloneable, java.io.Serializable
extends java.lang.Cloneable, java.io.Serializable

Interface representing an ExtendedDataElement.

The following description is from the Common Base Event v1.0.1 specification entitled "Canonical Situation Data Format: The Common Base Event V1.0.1":

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:

RawData - This keyword is indicative of "as is" data that is meaningful only to the producer of the data (typically proprietary data). It may be in any form, including binary. It is intended to allow the data to be retrieved verbatim and to support tools that understand the format of the context.
RootHeader - This keyword is intended to identify the root ExtendedDataElement for a hierarchy of ExtendedDataElements that are defined by dataRefs.
LoggingLevel - This keyword is intended to specify the level of logging represeted as an integer. Higher numbers must include all the granularity of lower numbers.

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`	`addChildWithNoValue(java.lang.String name)` 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
`java.util.List`	`getChildren()` Returns the value of the 'Children' containment reference list.
`java.util.List`	`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.
`java.util.List`	`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()` Resolves the XSD `dateTime` 'values' attribute as a long (milliseconds) time stamp.
`long[]`	`getValuesAsDateAsLongArray()` Resolves the XSD `dateTime` 'values' attribute as an array of long (milliseconds) time stamps.
`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. null) state.
`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 XSD `dateTime` 'values' attribute as a long (milliseconds) time stamp and sets the 'Type' attribute to `TYPE_DATE_TIME`.
`void`	`setValuesAsDateAsLongArray(long[] values)` Sets the XSD `dateTime` 'values' attribute as an array of long (milliseconds) time stamps and sets the 'Type' attribute to `TYPE_DATE_TIME_ARRAY`.
`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.

Field Detail

TYPE_NO_VALUE

static final java.lang.String TYPE_NO_VALUE

Indicates that type for an extended data element that does not have a value.

See Also:: getType(), Constant Field Values

TYPE_NO_VALUE_VALUE

static final int TYPE_NO_VALUE_VALUE

Indicates that type for an extended data element that does not have a value.

See Also:: getType(), Constant Field Values

TYPE_BYTE

static final java.lang.String TYPE_BYTE

Indicates a byte value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_BYTE_VALUE

static final int TYPE_BYTE_VALUE

Indicates a byte value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_SHORT

static final java.lang.String TYPE_SHORT

Indicates a short value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_SHORT_VALUE

static final int TYPE_SHORT_VALUE

Indicates a short value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_INT

static final java.lang.String TYPE_INT

Indicates an integer value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_INT_VALUE

static final int TYPE_INT_VALUE

Indicates an integer value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_LONG

static final java.lang.String TYPE_LONG

Indicates a long value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_LONG_VALUE

static final int TYPE_LONG_VALUE

Indicates a long value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_FLOAT

static final java.lang.String TYPE_FLOAT

Indicates a float value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_FLOAT_VALUE

static final int TYPE_FLOAT_VALUE

Indicates a float value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_DOUBLE

static final java.lang.String TYPE_DOUBLE

Indicates a double value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_DOUBLE_VALUE

static final int TYPE_DOUBLE_VALUE

Indicates a double value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_STRING

static final java.lang.String TYPE_STRING

Indicates a string value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_STRING_VALUE

static final int TYPE_STRING_VALUE

Indicates a string value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_DATE_TIME

static final java.lang.String TYPE_DATE_TIME

Indicates a date time value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_DATE_TIME_VALUE

static final int TYPE_DATE_TIME_VALUE

Indicates a date time value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_BOOLEAN

static final java.lang.String TYPE_BOOLEAN

Indicates a boolean value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_BOOLEAN_VALUE

static final int TYPE_BOOLEAN_VALUE

Indicates a boolean value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_BYTE_ARRAY

static final java.lang.String TYPE_BYTE_ARRAY

Indicates an array of byte values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_BYTE_ARRAY_VALUE

static final int TYPE_BYTE_ARRAY_VALUE

Indicates an array of byte values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_SHORT_ARRAY

static final java.lang.String TYPE_SHORT_ARRAY

Indicates an array of short values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_SHORT_ARRAY_VALUE

static final int TYPE_SHORT_ARRAY_VALUE

Indicates an array of short values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_INT_ARRAY

static final java.lang.String TYPE_INT_ARRAY

Indicates an array of integer values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_INT_ARRAY_VALUE

static final int TYPE_INT_ARRAY_VALUE

Indicates an array of integer values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_LONG_ARRAY

static final java.lang.String TYPE_LONG_ARRAY

Indicates an array of long values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_LONG_ARRAY_VALUE

static final int TYPE_LONG_ARRAY_VALUE

Indicates an array of long values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_FLOAT_ARRAY

static final java.lang.String TYPE_FLOAT_ARRAY

Indicates an array of float values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_FLOAT_ARRAY_VALUE

static final int TYPE_FLOAT_ARRAY_VALUE

Indicates an array of float values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_DOUBLE_ARRAY

static final java.lang.String TYPE_DOUBLE_ARRAY

Indicates an array of double values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_DOUBLE_ARRAY_VALUE

static final int TYPE_DOUBLE_ARRAY_VALUE

Indicates an array of double values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_STRING_ARRAY

static final java.lang.String TYPE_STRING_ARRAY

Indicates an array of string values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_STRING_ARRAY_VALUE

static final int TYPE_STRING_ARRAY_VALUE

Indicates an array of string values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_DATE_TIME_ARRAY

static final java.lang.String TYPE_DATE_TIME_ARRAY

Indicates an array of date time values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_DATE_TIME_ARRAY_VALUE

static final int TYPE_DATE_TIME_ARRAY_VALUE

Indicates an array of date time values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_BOOLEAN_ARRAY

static final java.lang.String TYPE_BOOLEAN_ARRAY

Indicates an array of boolean values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_BOOLEAN_ARRAY_VALUE

static final int TYPE_BOOLEAN_ARRAY_VALUE

Indicates an array of boolean values for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_HEX_BINARY

static final java.lang.String TYPE_HEX_BINARY

Indicates an hex binary value for the extended data element.

See Also:: getType(), Constant Field Values

TYPE_HEX_BINARY_VALUE

static final int TYPE_HEX_BINARY_VALUE

Indicates an hex binary value for the extended data element.

See Also:: getType(), Constant Field Values

Method Detail

getChildren

java.util.List getChildren(java.lang.String name)

Helper method to return a named child ExtendedDataElement from the list of children ExtendedDataElements.

Parameters:: name - the name of the child ExtendedDataElement
Returns:: a list of ExtendedDataElement objects.

getChildren

java.util.List getChildren()

Returns the value of the 'Children' containment reference list. The list contents are of type 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.

Returns:: the value of the 'Children' containment reference list.

setHexValue

void setHexValue(java.lang.String value)

Sets the value of the ' 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 .

Parameters:: value - the new value of the 'Hex Value' attribute.
See Also:: getHexValue()

getHexValue

java.lang.String getHexValue()

Returns the value of the 'Hex Value' attribute.

The value is represented according to the XML schema hexBinary definition .

Returns:: the value of the 'Hex Value' attribute.
See Also:: setHexValue(String)

setName

void setName(java.lang.String value)

Sets the value of the ' 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.

Parameters:: value - the new value of the 'Name' attribute.
See Also:: getName()

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

Returns:: the value of the 'Name' attribute.
See Also:: setName(String)

setType

void setType(java.lang.String value)

Sets the value of the ' Type' attribute.

The data type of the values specified in the values property.

Valid types are as follows:

byte, short, int, long, float, double
string
dateTime
byteArray, shortArray, intArray, longArray, floatArray, doubleArray
stringArray
dateTimeArray
hexBinary
boolean, booleanArray
noValue

These are the only valid data types for the ExtendedDataElement type.

The default value is "string". This is a required property. The string length for this property must not exceed 64 characters.

Parameters:: value - the new value of the 'Type' attribute.
See Also:: getType()

getType

java.lang.String getType()

Returns the value of the 'Type' attribute.

Returns:: the value of the 'Type' attribute.
See Also:: setType(String)

setTypeAsInt

void setTypeAsInt(int value)

Sets the value of the ' Type' attribute.

The value must be one of the ExtendedDataElement.TYPE_<type>_VALUE constants.

Parameters:: value - the new value of the 'Type' attribute.
See Also:: getType(), getTypeAsInt()

getTypeAsInt

int getTypeAsInt()

Returns the value of the 'Type' attribute.

The value is represented through one of the ExtendedDataElement.TYPE_<type>_VALUE constants.

Returns:: the value of the 'Type' attribute.
See Also:: setType(String), setTypeAsInt(int)

clearValues

void clearValues()

Removes all values that this event is referencing

getValues

java.util.List getValues()

Returns the value of the 'Values' attribute list. The list contents are of type 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.

Returns:: the value of the 'Values' attribute list.

setValues

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. hexBinary values MUST be defined using the hexValue property. This is an OPTIONAL property.

Parameters:: values - the values to set
Throws:: InvalidExtendedDataElementTypeException - if the extended data element is a hexBinary data type.

setValuesAsByte

void setValuesAsByte(byte value)

Sets the value of the extended data element as a byte value.

It also changes the 'Type' attribute to TYPE_BYTE.

Parameters:: value - the new value for the extended data element.

setValuesAsByteArray

void setValuesAsByteArray(byte[] value)

Sets the value of the extended data element as an array of bytes.

It also changes the 'Type' attribute to TYPE_BYTE_ARRAY.

Parameters:: value - the new value for the extended data element.

getValuesAsByte

byte getValuesAsByte()

Returns the value of the extended data element cast as a byte value.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_BYTE.

getValuesAsByteArray

byte[] getValuesAsByteArray()

Returns the values of the extended data element cast as byte values.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_BYTE_ARRAY.

setValuesAsBoolean

void setValuesAsBoolean(boolean value)

Sets the value of the extended data element as a boolean value.

It also changes the 'Type' attribute to TYPE_BOOLEAN.

Parameters:: value - the new value for the extended data element.

setValuesAsBooleanArray

void setValuesAsBooleanArray(boolean[] value)

Sets the value of the extended data element as an array of boolean values.

It also changes the 'Type' attribute to TYPE_BOOLEAN_ARRAY.

Parameters:: value - the new value for the extended data element.

getValuesAsBoolean

boolean getValuesAsBoolean()

Returns the value of the extended data element cast as a boolean value.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_BOOLEAN.

getValuesAsBooleanArray

boolean[] getValuesAsBooleanArray()

Returns the values of the extended data element cast as boolean values.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_BOOLEAN_ARRAY.

setValuesAsDate

void setValuesAsDate(java.lang.String value)

Sets the value of the extended data element as a date time value.

The values are represented according to the XML schema dateTime definition .

It also changes the 'Type' attribute to TYPE_DATE_TIME.

Parameters:: value - the new value for the extended data element.

setValuesAsDateArray

void setValuesAsDateArray(java.lang.String[] value)

Sets the value of the extended data element as an array of date time values.

The values are represented according to the XML schema dateTime definition .

It also changes the 'Type' attribute to TYPE_DATE_TIME_ARRAY.

Parameters:: value - the new value for the extended data element.

setValuesAsDateAsLong

void setValuesAsDateAsLong(long value)

Sets the XSD dateTime 'values' attribute as a long (milliseconds) time stamp and sets the 'Type' attribute to TYPE_DATE_TIME.

See EventHelpers#dateToLong(String) for more information on the long (milliseconds) and XSD dateTime time stamp formats and the conversion from a long time stamp to an XSD dateTime time stamp.

Parameters:: value - The long (milliseconds) time stamp to be converted to the XSD dateTime 'values' attribute.
See Also:: EventHelpers#dateToLong(String)

setValuesAsDateAsLongArray

void setValuesAsDateAsLongArray(long[] values)

Sets the XSD dateTime 'values' attribute as an array of long (milliseconds) time stamps and sets the 'Type' attribute to TYPE_DATE_TIME_ARRAY.

See EventHelpers#dateToLong(String) for more information on the long (milliseconds) and XSD dateTime time stamp formats and the conversion from a long time stamp to an XSD dateTime time stamp.

Parameters:: newValues - The array of long (milliseconds) time stamps to be converted to the XSD dateTime 'values' attribute.
See Also:: EventHelpers#dateToLong(String)

getValuesAsDateAsLong

long getValuesAsDateAsLong()

Resolves the XSD dateTime 'values' attribute as a long (milliseconds) time stamp.

See EventHelpers#dateToLong(String) for more information on the XSD dateTime and long (milliseconds) time stamp formats and the conversion from an XSD dateTime time stamp to a long time stamp.

Returns:: The long (milliseconds) time stamp representation of the XSD dateTime 'values Time' attribute.
Throws:: java.lang.IllegalStateException - If the 'Type' attribute is not TYPE_DATE_TIME.
See Also:: EventHelpers#dateToLong(String)

getValuesAsDate

java.lang.String getValuesAsDate()

Returns the value of the extended data element cast as a date/time value.

The value is represented according to the XML schema dateTime definition .

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_DATE_TIME.

getValuesAsDateAsLongArray

long[] getValuesAsDateAsLongArray()

Resolves the XSD dateTime 'values' attribute as an array of long (milliseconds) time stamps.

See EventHelpers#dateToLong(String) for more information on the XSD dateTime and long (milliseconds) time stamp formats and the conversion from an XSD dateTime time stamp to a long time stamp.

Returns:: The array of long (milliseconds) time stamps representation of the XSD dateTime 'values' attribute.
Throws:: java.lang.IllegalStateException - If the 'Type' attribute is not TYPE_DATE_TIME_ARRAY.
See Also:: EventHelpers#dateToLong(String)

getValuesAsDateArray

java.lang.String[] getValuesAsDateArray()

Returns the value of the extended data element cast as a date/time values.

The values are represented according to the XML schema dateTime definition .

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_DATE_TIME_ARRAY.

setValuesAsDouble

void setValuesAsDouble(double value)

Sets the value of the extended data element as a double value.

It also changes the 'Type' attribute to TYPE_DOUBLE.

Parameters:: value - the new value for the extended data element.

setValuesAsDoubleArray

void setValuesAsDoubleArray(double[] value)

Sets the value of the extended data element as an array of double values.

It also changes the 'Type' attribute to TYPE_DOUBLE_ARRAY.

Parameters:: value - the new value for the extended data element.

getValuesAsDouble

double getValuesAsDouble()

Returns the value of the extended data element cast as a double value.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_DOUBLE.

getValuesAsDoubleArray

double[] getValuesAsDoubleArray()

Returns the values of the extended data element cast as double values.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_DOUBLE_ARRAY.

setValuesAsFloat

void setValuesAsFloat(float value)

Sets the value of the extended data element as a float value.

It also changes the 'Type' attribute to TYPE_FLOAT.

Parameters:: value - the new value for the extended data element.

setValuesAsFloatArray

void setValuesAsFloatArray(float[] value)

Sets the value of the extended data element as an array of float values.

It also changes the 'Type' attribute to TYPE_FLOAT_ARRAY.

Parameters:: value - the new value for the extended data element.

getValuesAsFloat

float getValuesAsFloat()

Returns the value of the extended data element cast as a float value.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_FLOAT.

getValuesAsFloatArray

float[] getValuesAsFloatArray()

Returns the values of the extended data element cast as float values.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_FLOAT_ARRAY.

setValuesAsInt

void setValuesAsInt(int value)

Sets the value of the extended data element as a int value.

It also changes the 'Type' attribute to TYPE_INT.

Parameters:: value - the new value for the extended data element.

setValuesAsIntArray

void setValuesAsIntArray(int[] value)

Sets the value of the extended data element as an array of integer values.

It also changes the 'Type' attribute to TYPE_INT_ARRAY.

Parameters:: value - the new value for the extended data element.

getValuesAsInt

int getValuesAsInt()

Returns the value of the extended data element cast as an integer value.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_INT.

getValuesAsIntArray

int[] getValuesAsIntArray()

Returns the values of the extended data element cast as integer values.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_INT_ARRAY.

setValuesAsLong

void setValuesAsLong(long value)

Sets the value of the extended data element as a long value.

It also changes the 'Type' attribute to TYPE_LONG.

Parameters:: value - the new value for the extended data element.

setValuesAsLongArray

void setValuesAsLongArray(long[] value)

Sets the value of the extended data element as an array of long values.

It also changes the 'Type' attribute to TYPE_LONG_ARRAY.

Parameters:: value - the new value for the extended data element.

getValuesAsLong

long getValuesAsLong()

Returns the value of the extended data element cast as a long value.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_LONG.

getValuesAsLongArray

long[] getValuesAsLongArray()

Returns the values of the extended data element cast as long values.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_LONG_ARRAY.

setValuesAsShort

void setValuesAsShort(short value)

Sets the value of the extended data element as a short value.

It also changes the 'Type' attribute to TYPE_SHORT.

Parameters:: value - the new value for the extended data element.

setValuesAsShortArray

void setValuesAsShortArray(short[] value)

Sets the value of the extended data element as an array of short values.

It also changes the 'Type' attribute to TYPE_SHORT_ARRAY.

Parameters:: value - the new value for the extended data element.

getValuesAsShort

short getValuesAsShort()

Returns the value of the extended data element cast as a short value.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_SHORT.

getValuesAsShortArray

short[] getValuesAsShortArray()

Returns the values of the extended data element cast as short values.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_SHORT_ARRAY.

setValuesAsString

void setValuesAsString(java.lang.String value)

Sets the value of the extended data element as a string value.

It also changes the 'Type' attribute to TYPE_STRING.

Parameters:: value - the new value for the extended data element.

setValuesAsStringArray

void setValuesAsStringArray(java.lang.String[] value)

Sets the value of the extended data element as an array of string values.

It also changes the 'Type' attribute to TYPE_STRING_ARRAY.

Parameters:: value - the new value for the extended data element.

getValuesAsString

java.lang.String getValuesAsString()

Returns the value of the extended data element cast as a string value.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_STRING.

getValuesAsStringArray

java.lang.String[] getValuesAsStringArray()

Returns the values of the extended data element cast as string values.

Returns:: the value of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_STRING_ARRAY.

getHexValueAsByteArray

byte[] getHexValueAsByteArray()

Returns the hexValue of the extended data element cast as byte array values.

Returns:: the hexValue of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_HEX_BINARY.

getHexValueAsCharArray

char[] getHexValueAsCharArray()

Returns the hexValue of the extended data element cast as char array values.

Returns:: the hexValue of the extended data element.
Throws:: java.lang.IllegalStateException - if the 'Type' attribute is not TYPE_HEX_BINARY.

setHexValueAsByteArray

void setHexValueAsByteArray(byte[] value)

Sets the hexValue of the extended data element as an array of bytes.

It also changes the 'Type' attribute to TYPE_HEX_BINARY.

Parameters:: value - the new hexValue for the extended data element.

setHexValueAsCharArray

void setHexValueAsCharArray(char[] value)

Sets the hexValue of the extended data element as an array of chars.

It also changes the 'Type' attribute to TYPE_HEX_BINARY.

Parameters:: value - the new hexValue for the extended data element.

addChild

ExtendedDataElement addChild(ExtendedDataElement child)

Adds a new child ExtendedDataElement to this object.

Parameters:: child - the new child extended data element.
Returns:: a reference to the child extended data element added to this object.
See Also:: getChildren()

clearChildren

void clearChildren()

Removes all child ExtenedDataElements that this event is referencing

removeChildren

void removeChildren(java.lang.String name)

Remove a named child extended data element that this event is referencing

Parameters:: name - the name of the child element to be removed