org.eclipse.tptp.logging.events.cbe.impl
Class ExtendedDataElementImpl

java.lang.Object
  org.eclipse.tptp.logging.events.cbe.impl.ExtendedDataElementImpl

All Implemented Interfaces:

java.lang.Cloneable, ExtendedDataElement, java.io.Serializable

public class ExtendedDataElementImpl

extends java.lang.Object

implements ExtendedDataElement

Class representing an implementation of 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.

Since:

1.0.1

See Also:

Serialized Form

Field Summary

protected java.util.List	children The cached value of the 'Children' containment reference list.
protected java.lang.String	hexValue The cached value of the 'Hex Value' attribute.
protected java.lang.String	name The cached value of the 'Name' attribute.
protected java.lang.String	type The cached value of the 'Type' attribute.
protected java.util.List	values The cached value of the 'Values' attribute list.

Fields inherited from interface org.eclipse.tptp.logging.events.cbe.ExtendedDataElement

TYPE_BOOLEAN, TYPE_BOOLEAN_ARRAY, TYPE_BOOLEAN_ARRAY_VALUE, TYPE_BOOLEAN_VALUE, TYPE_BYTE, TYPE_BYTE_ARRAY, TYPE_BYTE_ARRAY_VALUE, TYPE_BYTE_VALUE, TYPE_DATE_TIME, TYPE_DATE_TIME_ARRAY, TYPE_DATE_TIME_ARRAY_VALUE, TYPE_DATE_TIME_VALUE, TYPE_DOUBLE, TYPE_DOUBLE_ARRAY, TYPE_DOUBLE_ARRAY_VALUE, TYPE_DOUBLE_VALUE, TYPE_FLOAT, TYPE_FLOAT_ARRAY, TYPE_FLOAT_ARRAY_VALUE, TYPE_FLOAT_VALUE, TYPE_HEX_BINARY, TYPE_HEX_BINARY_VALUE, TYPE_INT, TYPE_INT_ARRAY, TYPE_INT_ARRAY_VALUE, TYPE_INT_VALUE, TYPE_LONG, TYPE_LONG_ARRAY, TYPE_LONG_ARRAY_VALUE, TYPE_LONG_VALUE, TYPE_NO_VALUE, TYPE_NO_VALUE_VALUE, TYPE_SHORT, TYPE_SHORT_ARRAY, TYPE_SHORT_ARRAY_VALUE, TYPE_SHORT_VALUE, TYPE_STRING, TYPE_STRING_ARRAY, TYPE_STRING_ARRAY_VALUE, TYPE_STRING_VALUE

Constructor Summary

protected

ExtendedDataElementImpl()

Method Summary

ExtendedDataElement	addChild(ExtendedDataElement child) Adds a new child ExtendedDataElement to this object.
ExtendedDataElement	addChild(java.lang.String newName) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChild(java.lang.String newName, int newType, java.lang.String value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChild(java.lang.String newName, int newType, java.lang.String[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChild(java.lang.String newName, java.lang.String value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChild(java.lang.String newName, java.lang.String[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithBooleanArrayValue(java.lang.String newName, boolean[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithBooleanValue(java.lang.String newName, boolean value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithByteArrayValue(java.lang.String newName, byte[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithByteValue(java.lang.String newName, byte value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithDateArrayValue(java.lang.String newName, java.lang.String[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithDateAsLongValue(java.lang.String newName, long value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithDatesAsLongValue(java.lang.String newName, long[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithDateValue(java.lang.String newName, java.lang.String value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithDoubleArrayValue(java.lang.String newName, double[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithDoubleValue(java.lang.String newName, double value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithFloatArrayValue(java.lang.String newName, float[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithFloatValue(java.lang.String newName, float value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithHexValue(java.lang.String newName, java.lang.String value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithHexValueAsByteArray(java.lang.String newName, byte[] value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithIntArrayValue(java.lang.String newName, int[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithIntValue(java.lang.String newName, int value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithLongArrayValue(java.lang.String newName, long[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithLongValue(java.lang.String newName, long value) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithNoValue(java.lang.String newName) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithShortArrayValue(java.lang.String newName, short[] newValues) Adds a new ExtendedDataElement to this object.
ExtendedDataElement	addChildWithShortValue(java.lang.String newName, 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.lang.Object	clone() Return a cloned (copy by value) object of this object.
boolean	equals(java.lang.Object object) Overrides the java.lang.Object's equals() API to determine if the parameter object is equal to this object.
java.util.List	getChildren() Returns the value of the 'Children' containment reference list.
java.util.List	getChildren(java.lang.String newName) Helper method to return a named child ExtendedDataElement from the list of children ExtendedDataElements.
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.
static boolean	isValid(int type)
static boolean	isValid(java.lang.String type)
void	removeChildren(java.lang.String name) Remove a named child extended data element that this event is referencing
void	setHexValue(java.lang.String newHexValue) 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 newName) Sets the value of the ' Name' attribute.
void	setType(java.lang.String newType) Sets the value of the ' Type' attribute.
void	setTypeAsInt(int value) Sets the value of the ' Type' attribute.
protected void	setValues(java.lang.String value) Sets the value of the extended data element as String value.
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 ExtendedDataElement.TYPE_DATE_TIME.
void	setValuesAsDateAsLongArray(long[] newValues) Sets the XSD dateTime 'values' attribute as an array of long (milliseconds) time stamps and sets the 'Type' attribute to ExtendedDataElement.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.
java.lang.String	toString()
static int	typeToInt(java.lang.String type)
static java.lang.String	typeToString(int type)
void	validate() Checks whether the contents of the instance conform to the Common Base Event specification as described in "Canonical Situation Data Format: The Common Base Event V1.0.1".

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

hexValue

protected java.lang.String hexValue

The cached value of the 'Hex Value' attribute.

See Also:

getHexValue()

name

protected java.lang.String name

The cached value of the 'Name' attribute.

See Also:

getName()

type

protected java.lang.String type

The cached value of the 'Type' attribute.

See Also:

getType()

values

protected java.util.List values

The cached value of the 'Values' attribute list.

See Also:

getValues()

children

protected java.util.List children

The cached value of the 'Children' containment reference list.

See Also:

getChildren()

Constructor Detail

ExtendedDataElementImpl

protected ExtendedDataElementImpl()

Method Detail

getChildren

public java.util.List getChildren()

Description copied from interface: ExtendedDataElement

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.

Specified by:

getChildren in interface ExtendedDataElement

Returns:

the value of the 'Children' containment reference list.

getChildren

public java.util.List getChildren(java.lang.String newName)

Description copied from interface: ExtendedDataElement

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

Specified by:

getChildren in interface ExtendedDataElement

Parameters:

newName - the name of the child ExtendedDataElement

Returns:

a list of ExtendedDataElement objects.

See Also:

ExtendedDataElement.getChildren(String)

setHexValue

public void setHexValue(java.lang.String newHexValue)

Description copied from interface: ExtendedDataElement

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 .

Specified by:

setHexValue in interface ExtendedDataElement

Parameters:

newHexValue - the new value of the 'Hex Value' attribute.

See Also:

ExtendedDataElement.getHexValue()

getHexValue

public java.lang.String getHexValue()

Description copied from interface: ExtendedDataElement

Returns the value of the 'Hex Value' attribute.

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

Specified by:

getHexValue in interface ExtendedDataElement

Returns:

the value of the 'Hex Value' attribute.

See Also:

ExtendedDataElement.setHexValue(String)

setHexValueAsByteArray

public void setHexValueAsByteArray(byte[] value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_HEX_BINARY.

Specified by:

setHexValueAsByteArray in interface ExtendedDataElement

Parameters:

value - the new hexValue for the extended data element.

See Also:

ExtendedDataElement.setHexValueAsByteArray(byte[])

setHexValueAsCharArray

public void setHexValueAsCharArray(char[] value)

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_HEX_BINARY.

Specified by:

setHexValueAsCharArray in interface ExtendedDataElement

Parameters:

value - the new hexValue for the extended data element.

getHexValueAsByteArray

public byte[] getHexValueAsByteArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getHexValueAsByteArray in interface ExtendedDataElement

Returns:

the hexValue of the extended data element.

See Also:

ExtendedDataElement.getHexValueAsByteArray()

getHexValueAsCharArray

public char[] getHexValueAsCharArray()

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

Specified by:

getHexValueAsCharArray in interface ExtendedDataElement

Returns:

the hexValue of the extended data element.

Throws:

java.lang.IllegalStateException - if the 'Type' attribute is not ExtendedDataElement.TYPE_HEX_BINARY.

setName

public void setName(java.lang.String newName)

Description copied from interface: ExtendedDataElement

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.

Specified by:

setName in interface ExtendedDataElement

Parameters:

newName - the new value of the 'Name' attribute.

See Also:

ExtendedDataElement.getName()

getName

public java.lang.String getName()

Description copied from interface: ExtendedDataElement

Returns the value of the 'Name' attribute.

Specified by:

getName in interface ExtendedDataElement

Returns:

the value of the 'Name' attribute.

See Also:

ExtendedDataElement.setName(String)

setType

public void setType(java.lang.String newType)

Description copied from interface: ExtendedDataElement

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.

Specified by:

setType in interface ExtendedDataElement

Parameters:

newType - the new value of the 'Type' attribute.

See Also:

ExtendedDataElement.getType()

getType

public java.lang.String getType()

Description copied from interface: ExtendedDataElement

Returns the value of the 'Type' attribute.

Specified by:

getType in interface ExtendedDataElement

Returns:

the value of the 'Type' attribute.

See Also:

ExtendedDataElement.setType(String)

setTypeAsInt

public void setTypeAsInt(int value)

Description copied from interface: ExtendedDataElement

Sets the value of the ' Type' attribute.

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

Specified by:

setTypeAsInt in interface ExtendedDataElement

Parameters:

value - the new value of the 'Type' attribute.

See Also:

ExtendedDataElement.setTypeAsInt(int)

getTypeAsInt

public int getTypeAsInt()

Description copied from interface: ExtendedDataElement

Returns the value of the 'Type' attribute.

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

Specified by:

getTypeAsInt in interface ExtendedDataElement

Returns:

the value of the 'Type' attribute.

See Also:

ExtendedDataElement.getTypeAsInt()

getValues

public java.util.List getValues()

Description copied from interface: ExtendedDataElement

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.

Specified by:

getValues in interface ExtendedDataElement

Returns:

the value of the 'Values' attribute list.

setValues

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

Specified by:

setValues in interface ExtendedDataElement

Parameters:

values - the values to set

setValuesAsBoolean

public void setValuesAsBoolean(boolean value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_BOOLEAN.

Specified by:

setValuesAsBoolean in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsBoolean(boolean)

getValuesAsBoolean

public boolean getValuesAsBoolean()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsBoolean in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsBoolean()

setValuesAsBooleanArray

public void setValuesAsBooleanArray(boolean[] value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_BOOLEAN_ARRAY.

Specified by:

setValuesAsBooleanArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsBooleanArray(boolean[])

getValuesAsBooleanArray

public boolean[] getValuesAsBooleanArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsBooleanArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsBooleanArray()

setValuesAsByte

public void setValuesAsByte(byte value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_BYTE.

Specified by:

setValuesAsByte in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsByte(byte)

getValuesAsByte

public byte getValuesAsByte()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsByte in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsByte()

setValuesAsByteArray

public void setValuesAsByteArray(byte[] value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_BYTE_ARRAY.

Specified by:

setValuesAsByteArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsByteArray(byte[])

getValuesAsByteArray

public byte[] getValuesAsByteArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsByteArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsByteArray()

setValuesAsDate

public void setValuesAsDate(java.lang.String value)

Description copied from interface: ExtendedDataElement

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 ExtendedDataElement.TYPE_DATE_TIME.

Specified by:

setValuesAsDate in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsDate(String)

getValuesAsDate

public java.lang.String getValuesAsDate()

Description copied from interface: ExtendedDataElement

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 .

Specified by:

getValuesAsDate in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsDate()

setValuesAsDateArray

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

Description copied from interface: ExtendedDataElement

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 ExtendedDataElement.TYPE_DATE_TIME_ARRAY.

Specified by:

setValuesAsDateArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsDateArray(String[])

getValuesAsDateArray

public java.lang.String[] getValuesAsDateArray()

Description copied from interface: ExtendedDataElement

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 .

Specified by:

getValuesAsDateArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsDateArray()

setValuesAsDateAsLong

public void setValuesAsDateAsLong(long value)

Sets the XSD dateTime 'values' attribute as a long (milliseconds) time stamp and sets the 'Type' attribute to ExtendedDataElement.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.

Specified by:

setValuesAsDateAsLong in interface ExtendedDataElement

Parameters:

value - The long (milliseconds) time stamp to be converted to the XSD dateTime 'values' attribute.

See Also:

ExtendedDataElement.setValuesAsDateAsLong(long), EventHelpers.dateToLong(String)

getValuesAsDateAsLong

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

Specified by:

getValuesAsDateAsLong in interface ExtendedDataElement

Returns:

The long (milliseconds) time stamp representation of the XSD dateTime 'values' attribute.

Throws:

java.lang.IllegalStateException - If the 'Type' attribute is not ExtendedDataElement.TYPE_DATE_TIME.

See Also:

ExtendedDataElement.getValuesAsDateAsLong(), EventHelpers.dateToLong(String)

setValuesAsDateAsLongArray

public void setValuesAsDateAsLongArray(long[] newValues)

Sets the XSD dateTime 'values' attribute as an array of long (milliseconds) time stamps and sets the 'Type' attribute to ExtendedDataElement.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.

Specified by:

setValuesAsDateAsLongArray in interface ExtendedDataElement

Parameters:

newValues - The array of long (milliseconds) time stamps to be converted to the XSD dateTime 'values' attribute.

See Also:

ExtendedDataElement.setValuesAsDateAsLongArray(long[]), EventHelpers.dateToLong(String)

getValuesAsDateAsLongArray

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

Specified by:

getValuesAsDateAsLongArray in interface ExtendedDataElement

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 ExtendedDataElement.TYPE_DATE_TIME_ARRAY.

See Also:

ExtendedDataElement.getValuesAsDateAsLongArray(), EventHelpers.dateToLong(String)

setValuesAsDouble

public void setValuesAsDouble(double value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_DOUBLE.

Specified by:

setValuesAsDouble in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsDouble(double)

getValuesAsDouble

public double getValuesAsDouble()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsDouble in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsDouble()

setValuesAsDoubleArray

public void setValuesAsDoubleArray(double[] value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_DOUBLE_ARRAY.

Specified by:

setValuesAsDoubleArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsDoubleArray(double[])

getValuesAsDoubleArray

public double[] getValuesAsDoubleArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsDoubleArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsDoubleArray()

setValuesAsFloat

public void setValuesAsFloat(float value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_FLOAT.

Specified by:

setValuesAsFloat in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsFloat(float)

getValuesAsFloat

public float getValuesAsFloat()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsFloat in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsFloat()

setValuesAsFloatArray

public void setValuesAsFloatArray(float[] value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_FLOAT_ARRAY.

Specified by:

setValuesAsFloatArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsFloatArray(float[])

getValuesAsFloatArray

public float[] getValuesAsFloatArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsFloatArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsFloatArray()

setValuesAsInt

public void setValuesAsInt(int value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_INT.

Specified by:

setValuesAsInt in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsInt(int)

getValuesAsInt

public int getValuesAsInt()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsInt in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsInt()

setValuesAsIntArray

public void setValuesAsIntArray(int[] value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_INT_ARRAY.

Specified by:

setValuesAsIntArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsIntArray(int[])

getValuesAsIntArray

public int[] getValuesAsIntArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsIntArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsIntArray()

setValuesAsLong

public void setValuesAsLong(long value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_LONG.

Specified by:

setValuesAsLong in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsLong(long)

getValuesAsLong

public long getValuesAsLong()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsLong in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsLong()

setValuesAsLongArray

public void setValuesAsLongArray(long[] value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_LONG_ARRAY.

Specified by:

setValuesAsLongArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsLongArray(long[])

getValuesAsLongArray

public long[] getValuesAsLongArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsLongArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsLongArray()

setValuesAsShort

public void setValuesAsShort(short value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_SHORT.

Specified by:

setValuesAsShort in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsShort(short)

getValuesAsShort

public short getValuesAsShort()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsShort in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsShort()

setValuesAsShortArray

public void setValuesAsShortArray(short[] value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_SHORT_ARRAY.

Specified by:

setValuesAsShortArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsShortArray(short[])

getValuesAsShortArray

public short[] getValuesAsShortArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsShortArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsShortArray()

setValuesAsString

public void setValuesAsString(java.lang.String value)

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_STRING.

Specified by:

setValuesAsString in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsString(java.lang.String)

getValuesAsString

public java.lang.String getValuesAsString()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsString in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsString()

setValuesAsStringArray

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

Description copied from interface: ExtendedDataElement

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

It also changes the 'Type' attribute to ExtendedDataElement.TYPE_STRING_ARRAY.

Specified by:

setValuesAsStringArray in interface ExtendedDataElement

Parameters:

value - the new value for the extended data element.

See Also:

ExtendedDataElement.setValuesAsStringArray(String[])

getValuesAsStringArray

public java.lang.String[] getValuesAsStringArray()

Description copied from interface: ExtendedDataElement

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

Specified by:

getValuesAsStringArray in interface ExtendedDataElement

Returns:

the value of the extended data element.

See Also:

ExtendedDataElement.getValuesAsStringArray()

addChild

public ExtendedDataElement addChild(ExtendedDataElement child)

Adds a new child ExtendedDataElement to this object.

Specified by:

addChild in interface ExtendedDataElement

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

public void clearChildren()

Removes all child ExtenedDataElements that this event is referencing

Specified by:

clearChildren in interface ExtendedDataElement

removeChildren

public void removeChildren(java.lang.String name)

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

Specified by:

removeChildren in interface ExtendedDataElement

Parameters:

name - the name of the child element to be removed

addChild

public ExtendedDataElement addChild(java.lang.String newName)

Description copied from interface: ExtendedDataElement

Adds a new ExtendedDataElement to this object.

It creates an ExtendedDataElement object without any values adds it to the list of extended data elements for this object.

Specified by:

addChild in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChild(String)

addChild

public ExtendedDataElement addChild(java.lang.String newName,
                                    int newType,
                                    java.lang.String value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChild in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newType - 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.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChild(String, int, String)

addChild

public ExtendedDataElement addChild(java.lang.String newName,
                                    int newType,
                                    java.lang.String[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChild in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newType - represents the data type for the new extended data element. Refer to the ExtendedDataElement.TYPE_<type>_VALUE constants for valid types.

newValues - the array of values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChild(String, int, String[])

addChild

public ExtendedDataElement addChild(java.lang.String newName,
                                    java.lang.String value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChild in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChild(String, String)

addChild

public ExtendedDataElement addChild(java.lang.String newName,
                                    java.lang.String[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChild in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of String values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChild(String, String[])

addChildWithBooleanArrayValue

public ExtendedDataElement addChildWithBooleanArrayValue(java.lang.String newName,
                                                         boolean[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithBooleanArrayValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of boolean values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithByteArrayValue(String, byte[])

addChildWithBooleanValue

public ExtendedDataElement addChildWithBooleanValue(java.lang.String newName,
                                                    boolean value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithBooleanValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithByteValue(String, byte)

addChildWithNoValue

public ExtendedDataElement addChildWithNoValue(java.lang.String newName)

Description copied from interface: ExtendedDataElement

Adds a new ExtendedDataElement to this object.

It creates an ExtendedDataElement object object containing no value and adds it to the list of extended data elements for this object.

Specified by:

addChildWithNoValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithNoValue(String)

addChildWithByteArrayValue

public ExtendedDataElement addChildWithByteArrayValue(java.lang.String newName,
                                                      byte[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithByteArrayValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of byte values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithByteArrayValue(String, byte[])

addChildWithByteValue

public ExtendedDataElement addChildWithByteValue(java.lang.String newName,
                                                 byte value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithByteValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithByteValue(String, byte)

addChildWithDateArrayValue

public ExtendedDataElement addChildWithDateArrayValue(java.lang.String newName,
                                                      java.lang.String[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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 .

Specified by:

addChildWithDateArrayValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of String instances representing the date time values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithDateArrayValue(String, String[])

addChildWithDateAsLongValue

public ExtendedDataElement addChildWithDateAsLongValue(java.lang.String newName,
                                                       long value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithDateAsLongValue in interface ExtendedDataElement

Parameters:

newName - 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.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithDateAsLongValue(String, long)

addChildWithDateValue

public ExtendedDataElement addChildWithDateValue(java.lang.String newName,
                                                 java.lang.String value)

Description copied from interface: ExtendedDataElement

Adds a new 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 .

Specified by:

addChildWithDateValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - representation of the date time value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithDateValue(String, String)

addChildWithDatesAsLongValue

public ExtendedDataElement addChildWithDatesAsLongValue(java.lang.String newName,
                                                        long[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithDatesAsLongValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of long values for the new extended data element. Each value corresponds to the number of milliseconds since January 1, 1970 UTC.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithDatesAsLongValue(String, long[])

addChildWithDoubleArrayValue

public ExtendedDataElement addChildWithDoubleArrayValue(java.lang.String newName,
                                                        double[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithDoubleArrayValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of double values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithDoubleArrayValue(String, double[])

addChildWithDoubleValue

public ExtendedDataElement addChildWithDoubleValue(java.lang.String newName,
                                                   double value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithDoubleValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the double value that the new ExtendedDataElement will contain.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithDoubleValue(String, double)

addChildWithFloatArrayValue

public ExtendedDataElement addChildWithFloatArrayValue(java.lang.String newName,
                                                       float[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithFloatArrayValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of float/code> values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithFloatArrayValue(String, float[])

addChildWithFloatValue

public ExtendedDataElement addChildWithFloatValue(java.lang.String newName,
                                                  float value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithFloatValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithFloatValue(String, float)

addChildWithHexValue

public ExtendedDataElement addChildWithHexValue(java.lang.String newName,
                                                java.lang.String value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithHexValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChild(String, String)

addChildWithHexValueAsByteArray

public ExtendedDataElement addChildWithHexValueAsByteArray(java.lang.String newName,
                                                           byte[] value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithHexValueAsByteArray in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChild(String, String)

addChildWithIntArrayValue

public ExtendedDataElement addChildWithIntArrayValue(java.lang.String newName,
                                                     int[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithIntArrayValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of int values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithIntArrayValue(String, int[])

addChildWithIntValue

public ExtendedDataElement addChildWithIntValue(java.lang.String newName,
                                                int value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithIntValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithIntValue(String, int)

addChildWithLongArrayValue

public ExtendedDataElement addChildWithLongArrayValue(java.lang.String newName,
                                                      long[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithLongArrayValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of long values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithLongArrayValue(String, long[])

addChildWithLongValue

public ExtendedDataElement addChildWithLongValue(java.lang.String newName,
                                                 long value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithLongValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithLongValue(String, long)

addChildWithShortArrayValue

public ExtendedDataElement addChildWithShortArrayValue(java.lang.String newName,
                                                       short[] newValues)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithShortArrayValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

newValues - the array of short values for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithShortArrayValue(String, short[])

addChildWithShortValue

public ExtendedDataElement addChildWithShortValue(java.lang.String newName,
                                                  short value)

Description copied from interface: ExtendedDataElement

Adds a new 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.

Specified by:

addChildWithShortValue in interface ExtendedDataElement

Parameters:

newName - the name for the new extended data element.

value - the value for the new extended data element.

Returns:

a reference to the extended data element added to this object.

See Also:

ExtendedDataElement.addChildWithShortValue(String, short)

equals

public boolean equals(java.lang.Object object)

Overrides the java.lang.Object's equals() API to determine if the parameter object is equal to this object.

Parameters:

object - The java.lang.Object to be compared to this object.

Returns:

True, if this object is the same as the parameter object, otherwise false.

See Also:

Object.equals(java.lang.Object)

toString

public java.lang.String toString()

isValid

public static boolean isValid(int type)

isValid

public static boolean isValid(java.lang.String type)

typeToString

public static java.lang.String typeToString(int type)

typeToInt

public static int typeToInt(java.lang.String type)

validate

public void validate()
              throws ValidationException

Checks whether the contents of the instance conform to the Common Base Event specification as described in "Canonical Situation Data Format: The Common Base Event V1.0.1".

Specified by:

validate in interface ExtendedDataElement

Throws:

ValidationException - If the event instance does not conform to the Common Base Event specification.

clearValues

public void clearValues()

Removes all values that this event is referencing

Specified by:

clearValues in interface ExtendedDataElement

clone

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

Return a cloned (copy by value) object of this object.

This is a deep copy version, in which all the objects within this object will be copied by value.

Returns:

Object The cloned (copy by value) object of this object.

Throws:

java.lang.CloneNotSupportedException - If a instance variable of this object does not implement the Cloneable interface.

init

public void init()

Resets the object's properties to their initial (e.g. null) state. All components are initialized to either zero or null.

Specified by:

init in interface ExtendedDataElement

Since:

1.0

setValues

protected void setValues(java.lang.String value)

Sets the value of the extended data element as String value.

Parameters:

value - the new value for the extended data element