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

java.lang.Object
  org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl
      org.eclipse.tptp.logging.events.cbe.impl.ReportSituationImpl

All Implemented Interfaces:

java.lang.Cloneable, ReportSituation, java.io.Serializable, SituationType

public class ReportSituationImpl

extends SituationTypeImpl

implements ReportSituation

Interface representing a ReportSituation.

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 ReportSituation deals with the situations reported from the component, such as heartbeat or performance information. Data such as current CPU utilization, current memory heap size, etc. would fall into this category. Existing messages include words like "utilization value is", "buffer size is", and "number of threads is", for example:

• IEE890I WTO Buffers in console backup storage = 1024

Since:

1.0.1

See Also:

Serialized Form

Field Summary

protected java.lang.String

reportCategory The cached value of the ' Report Category' attribute.

Fields inherited from class org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl

reasoningScope

Constructor Summary

protected

ReportSituationImpl()

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	getReportCategory() Returns the value of the 'Report Category' attribute.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setReportCategory(java.lang.String newReportCategory) Sets the value of the ' Report Category' 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 org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl

getReasoningScope, setReasoningScope

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.tptp.logging.events.cbe.SituationType

getReasoningScope, setReasoningScope

Field Detail

reportCategory

protected java.lang.String reportCategory

The cached value of the ' Report Category' attribute.

See Also:

getReportCategory()

Constructor Detail

ReportSituationImpl

protected ReportSituationImpl()

Method Detail

getReportCategory

public java.lang.String getReportCategory()

Description copied from interface: ReportSituation

Returns the value of the 'Report Category' attribute.

Specified by:

getReportCategory in interface ReportSituation

Returns:

the value of the 'Report Category' attribute.

See Also:

ReportSituation.setReportCategory(String)

setReportCategory

public void setReportCategory(java.lang.String newReportCategory)

Description copied from interface: ReportSituation

Sets the value of the ' Report Category' attribute.

This property specifies the category of the reported situation. The reportCategory is a string with the following set of values:

• PERFORMANCE
• SECURITY
• HEARTBEAT
• STATUS

This is a required property and once it is set it must not change. The string length for this property must not exceed 64 characters.

Specified by:

setReportCategory in interface ReportSituation

Parameters:

newReportCategory - the new value of the 'Report Category' attribute.

See Also:

ReportSituation.getReportCategory()

toString

public java.lang.String toString()

Overrides:

toString in class SituationTypeImpl

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 SituationType

Overrides:

validate in class SituationTypeImpl

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.

Overrides:

clone in class SituationTypeImpl

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.

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.

Overrides:

equals in class SituationTypeImpl

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)

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 ReportSituation

Overrides:

init in class SituationTypeImpl

Since:

1.0