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

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

AssociationEngineImpl

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

Interface representing 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.

Field Summary

static java.lang.String	TYPE_CAUSED_BY Value for the Type attribute.
static java.lang.String	TYPE_CLEARED Value for the Type attribute.
static java.lang.String	TYPE_CONTAIN Value for the Type attribute.
static java.lang.String	TYPE_CORRELATED Value for the Type attribute.
static java.lang.String	TYPE_MULTI_PART Value for the Type attribute.

Method Summary

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, except the id property.
void	setId(java.lang.String value) Sets the value of the ' Id' attribute.
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	validate() Checks whether the contents of this object conforms to the CBE specification.

Field Detail

TYPE_CONTAIN

static final java.lang.String TYPE_CONTAIN

Value for the Type attribute.

The association represents containment of other events within a root event.

See Also:

getType(), Constant Field Values

TYPE_CAUSED_BY

static final java.lang.String TYPE_CAUSED_BY

Value for the Type attribute.

The association represents a causality allowing the associated event to point to the cause of the situation.

See Also:

getType(), Constant Field Values

TYPE_CLEARED

static final java.lang.String TYPE_CLEARED

Value for the Type attribute.

The association represents a relationship where an event points to an event that fixes or results in the situation becoming irrelevant.

See Also:

getType(), Constant Field Values

TYPE_MULTI_PART

static final java.lang.String TYPE_MULTI_PART

Value for the Type attribute.

The association represents a collection of events together compose a single event.

See Also:

getType(), Constant Field Values

TYPE_CORRELATED

static final java.lang.String TYPE_CORRELATED

Value for the Type attribute.

The association represents a relationship between a child and parent event based on a correlation algorithm specified in the name of the association.

See Also:

getType(), Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns the value of the 'Id' attribute.

Returns:

the value of the 'Id' attribute.

See Also:

setId(String)

setId

void setId(java.lang.String value)

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.

Parameters:

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

See Also:

getId()

getType

java.lang.String getType()

Returns the value of the 'Type' attribute.

Returns:

the value of the 'Type' attribute.

See Also:

setType(String)

setType

void setType(java.lang.String value)

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.

Parameters:

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

See Also:

getType()

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

Returns:

the value of the 'Name' attribute.

See Also:

setName(String)

setName

void setName(java.lang.String value)

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.

Parameters:

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

See Also:

getName()

validate

void validate()
              throws ValidationException

Checks whether the contents of this object conforms to the CBE specification.

Throws:

ValidationException - if the object does not follow the CBE specification.

init

void init()

Resets the object's properties to their initial (e.g. null) state, except the id property.

This API assigns a new unique GUID to the id property.