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

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

All Implemented Interfaces:

AssociationEngine, java.lang.Cloneable, java.io.Serializable

public class AssociationEngineImpl

extends java.lang.Object

implements AssociationEngine

Class representing an implementation of an AssociationEngine.

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 AssociationEngine identifies the application that establishes associations among related or associated events. In addition, it provides properties to describe the types of the associations.

The AssociationEngine is a standalone entity in the XML schema and the AssociatedEvents created by the application that is identified by the AssociationEngine refer to it. This will eliminate the need to repeat the same data in every associated event.

Since:

1.0.1

See Also:

Serialized Form

Field Summary

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

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

TYPE_CAUSED_BY, TYPE_CLEARED, TYPE_CONTAIN, TYPE_CORRELATED, TYPE_MULTI_PART

Constructor Summary

protected

AssociationEngineImpl()

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	getId() Returns the value of the 'Id' 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	setId(java.lang.String newId) Sets the value of the ' Id' 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

id

protected java.lang.String id

The cached value of the 'Id' attribute.

See Also:

getId()

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

AssociationEngineImpl

protected AssociationEngineImpl()

Method Detail

setId

public void setId(java.lang.String newId)

Description copied from interface: AssociationEngine

Sets the value of the ' Id' attribute.

The primary identifier for the element. This property must be globally unique. The recommend value for this is either a 128 bit or 256 bit Globally Unique Id (represented as hex string). Once this value is set it must never be changed. This is a required property.

Specified by:

setId in interface AssociationEngine

Parameters:

newId - the new value of the 'Id' attribute.

See Also:

AssociationEngine.getId()

getId

public java.lang.String getId()

Description copied from interface: AssociationEngine

Returns the value of the 'Id' attribute.

Specified by:

getId in interface AssociationEngine

Returns:

the value of the 'Id' attribute.

See Also:

AssociationEngine.setId(String)

setName

public void setName(java.lang.String newName)

Description copied from interface: AssociationEngine

Sets the value of the ' Name' attribute.

The name of the application that creates the association (for example, my correlation engine name). This is a required property. The string length for this property must not exceed 64 characters.

Specified by:

setName in interface AssociationEngine

Parameters:

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

See Also:

AssociationEngine.getName()

getName

public java.lang.String getName()

Description copied from interface: AssociationEngine

Returns the value of the 'Name' attribute.

Specified by:

getName in interface AssociationEngine

Returns:

the value of the 'Name' attribute.

See Also:

AssociationEngine.setName(String)

setType

public void setType(java.lang.String newType)

Description copied from interface: AssociationEngine

Sets the value of the ' Type' attribute.

This property should contain the type of association created by this AssociationEngine. Some well defined associations are:

• Contains
• Cleared
• CausedBy
• MultiPart
• Correlated

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

Specified by:

setType in interface AssociationEngine

Parameters:

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

See Also:

AssociationEngine.getType()

getType

public java.lang.String getType()

Description copied from interface: AssociationEngine

Returns the value of the 'Type' attribute.

Specified by:

getType in interface AssociationEngine

Returns:

the value of the 'Type' attribute.

See Also:

AssociationEngine.setType(String)

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

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 AssociationEngine

Throws:

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

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.

Specified by:

init in interface AssociationEngine

Since:

1.0