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

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

All Implemented Interfaces:

java.lang.Cloneable, ContextDataElement, java.io.Serializable

public class ContextDataElementImpl

extends java.lang.Object

implements ContextDataElement

Interface representing a ContextDataElement.

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 ContextDataElement type defines the contexts that this event references. This complex type holds data that is used to assist with problem diagnostics by correlating messages or events generated during execution of a unit of work.

Since:

1.0.1

See Also:

Serialized Form

Field Summary

protected java.lang.String	contextId The cached value of the 'Context Id' attribute.
protected java.lang.String	contextValue The cached value of the ' Context 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.

Constructor Summary

protected

ContextDataElementImpl()

Method Summary

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.lang.String	getContextId() Returns the value of the 'Context Id' attribute.
java.lang.String	getContextValue() Returns the value of the 'Context Value' attribute.
java.lang.String	getName() Returns the value of the 'Name' attribute.
java.lang.String	getType() Returns the value of the 'Type' attribute.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setContextId(java.lang.String newContextId) Sets the value of the ' Context Id' attribute.
void	setContextValue(java.lang.String newContextValue) Sets the value of the ' Context Value' attribute.
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.
java.lang.String	toString()
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

contextId

protected java.lang.String contextId

The cached value of the 'Context Id' attribute.

See Also:

getContextId()

contextValue

protected java.lang.String contextValue

The cached value of the ' Context Value' attribute.

See Also:

getContextValue()

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()

Constructor Detail

ContextDataElementImpl

protected ContextDataElementImpl()

Method Detail

getContextId

public java.lang.String getContextId()

Description copied from interface: ContextDataElement

Returns the value of the 'Context Id' attribute.

Specified by:

getContextId in interface ContextDataElement

Returns:

the value of the 'Context Id' attribute.

See Also:

ContextDataElement.setContextId(String)

setContextId

public void setContextId(java.lang.String newContextId)

Description copied from interface: ContextDataElement

Sets the value of the ' Context Id' attribute.

This property is the reference to the globally unique identifier of the element that contains the context.

This is required unless contextValue specifies a value.

Specified by:

setContextId in interface ContextDataElement

Parameters:

newContextId - the new value of the 'Context Id' attribute.

See Also:

ContextDataElement.getContextId()

getContextValue

public java.lang.String getContextValue()

Description copied from interface: ContextDataElement

Returns the value of the 'Context Value' attribute.

Specified by:

getContextValue in interface ContextDataElement

Returns:

the value of the 'Context Value' attribute.

See Also:

ContextDataElement.setContextValue(String)

setContextValue

public void setContextValue(java.lang.String newContextValue)

Description copied from interface: ContextDataElement

Sets the value of the ' Context Value' attribute.

The value of the context with respect to the implementation of the context.

This is required unless contextId specifies a value. The string length for this property must not exceed 1024 characters.

Specified by:

setContextValue in interface ContextDataElement

Parameters:

newContextValue - the new value of the 'Context Value' attribute.

See Also:

ContextDataElement.getContextValue()

getName

public java.lang.String getName()

Description copied from interface: ContextDataElement

Returns the value of the 'Name' attribute.

Specified by:

getName in interface ContextDataElement

Returns:

the value of the 'Name' attribute.

See Also:

ContextDataElement.setName(String)

setName

public void setName(java.lang.String newName)

Description copied from interface: ContextDataElement

Sets the value of the ' Name' attribute.

Name of the application that created this context data element.

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

Specified by:

setName in interface ContextDataElement

Parameters:

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

See Also:

ContextDataElement.getName()

getType

public java.lang.String getType()

Description copied from interface: ContextDataElement

Returns the value of the 'Type' attribute.

Specified by:

getType in interface ContextDataElement

Returns:

the value of the 'Type' attribute.

See Also:

ContextDataElement.setType(String)

setType

public void setType(java.lang.String newType)

Description copied from interface: ContextDataElement

Sets the value of the ' Type' attribute.

The data type of the contextValue property.

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

Specified by:

setType in interface ContextDataElement

Parameters:

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

See Also:

ContextDataElement.getType()

toString

public java.lang.String toString()

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 ContextDataElement

Throws:

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

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)

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 ContextDataElement

Since:

1.0