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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Situation

public class SituationImpl
extends java.lang.Object
implements Situation

Interface representing a Situation.

See Also:

Serialized Form

Field Summary

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

AVAILABLE_SITUATION_CATEGORY, CONFIGURE_SITUATION_CATEGORY, CONNECT_SITUATION_CATEGORY, CREATE_SITUATION_CATEGORY, DEPENDENCY_SITUATION_CATEGORY, DESTROY_SITUATION_CATEGORY, FEATURE_SITUATION_CATEGORY, OTHER_SITUATION_CATEGORY, REPORT_SITUATION_CATEGORY, REQUEST_SITUATION_CATEGORY, START_SITUATION_CATEGORY, STOP_SITUATION_CATEGORY

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	getCategoryName() Returns the value of the 'Category Name' attribute.
SituationType	getSituationType() Returns the value of the 'Situation Type' containment reference.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setAvailableSituation(java.lang.String reasoningScope, java.lang.String availabilityDisposition, java.lang.String operationDisposition, java.lang.String processingDisposition) Sets the value of the situation type as an Available Situation.
void	setCategoryName(java.lang.String newCategoryName) Sets the value of the ' Category Name' attribute.
void	setConfigureSituation(java.lang.String reasoningScope, java.lang.String successDisposition) Sets the value of the situation type as a Configure Situation.
void	setConnectSituation(java.lang.String reasoningScope, java.lang.String situationDisposition, java.lang.String successDisposition) Sets the value of the situation type as a Connect Situation.
void	setCreateSituation(java.lang.String reasoningScope, java.lang.String successDisposition) Sets the value of the situation type as a Create Situation.
void	setDependencySituation(java.lang.String reasoningScope, java.lang.String dependencyDisposition) Sets the value of the situation type as a Dependency Situation.
void	setDestroySituation(java.lang.String reasoningScope, java.lang.String successDisposition) Sets the value of the situation type as a Destroy Situation.
void	setFeatureSituation(java.lang.String reasoningScope, java.lang.String featureDisposition) Sets the value of the situation type as a Feature Situation.
void	setOtherSituation(java.lang.String reasoningScope, java.lang.String any) Sets the value of the situation type as an Other Situation.
void	setReportSituation(java.lang.String reasoningScope, java.lang.String reportCategory) Sets the value of the situation type as a Report Situation.
void	setRequestSituation(java.lang.String reasoningScope, java.lang.String situationQualifier, java.lang.String successDisposition) Sets the value of the situation type as a Request Situation.
void	setSituationType(SituationType newSituationType) Sets the value of the ' Situation Type' containment reference.
void	setStartSituation(java.lang.String reasoningScope, java.lang.String situationQualifier, java.lang.String successDisposition) Sets the value of the situation type as a Start Situation.
void	setStopSituation(java.lang.String reasoningScope, java.lang.String situationQualifier, java.lang.String successDisposition) Sets the value of the situation type as a Stop Situation.
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

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

Method Detail

setAvailableSituation

public void setAvailableSituation(java.lang.String reasoningScope,
                                  java.lang.String availabilityDisposition,
                                  java.lang.String operationDisposition,
                                  java.lang.String processingDisposition)

Description copied from interface: Situation

Sets the value of the situation type as an Available Situation.

It also changes the 'categoryName' attribute to Situation.AVAILABLE_SITUATION_CATEGORY.

Specified by:

setAvailableSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

availabilityDisposition - availability disposition for the situation.

operationDisposition - operation disposition for the situation.

processingDisposition - processing disposition for the situation.

See Also:

Situation.setAvailableSituation(String, String, String,String)

setCategoryName

public void setCategoryName(java.lang.String newCategoryName)

Description copied from interface: Situation

Sets the value of the ' Category Name' attribute.

Specified by:

setCategoryName in interface Situation

Parameters:

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

See Also:

Situation.getCategoryName()

getCategoryName

public java.lang.String getCategoryName()

Description copied from interface: Situation

Returns the value of the 'Category Name' attribute.

Specified by:

getCategoryName in interface Situation

Returns:

the value of the 'Category Name' attribute.

See Also:

Situation.setCategoryName(String)

setConfigureSituation

public void setConfigureSituation(java.lang.String reasoningScope,
                                  java.lang.String successDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Configure Situation.

It also changes the 'categoryName' attribute to Situation.CONFIGURE_SITUATION_CATEGORY.

Specified by:

setConfigureSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

successDisposition - success disposition for the new situation.

See Also:

Situation.setConfigureSituation(String,String)

setConnectSituation

public void setConnectSituation(java.lang.String reasoningScope,
                                java.lang.String situationDisposition,
                                java.lang.String successDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Connect Situation.

It also changes the 'categoryName' attribute to Situation.CONNECT_SITUATION_CATEGORY.

Specified by:

setConnectSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

situationDisposition - situation disposition for the new situation.

successDisposition - success disposition for the new situation.

See Also:

Situation.setConnectSituation(String, String,String)

setCreateSituation

public void setCreateSituation(java.lang.String reasoningScope,
                               java.lang.String successDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Create Situation.

It also changes the 'categoryName' attribute to Situation.CREATE_SITUATION_CATEGORY.

Specified by:

setCreateSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

successDisposition - success disposition for the new situation.

See Also:

Situation.setCreateSituation(String,String)

setDependencySituation

public void setDependencySituation(java.lang.String reasoningScope,
                                   java.lang.String dependencyDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Dependency Situation.

It also changes the 'categoryName' attribute to Situation.DEPENDENCY_SITUATION_CATEGORY.

Specified by:

setDependencySituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

dependencyDisposition - dependency disposition for the new situation.

See Also:

Situation.setDependencySituation(String,String)

setDestroySituation

public void setDestroySituation(java.lang.String reasoningScope,
                                java.lang.String successDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Destroy Situation.

It also changes the 'categoryName' attribute to Situation.DESTROY_SITUATION_CATEGORY.

Specified by:

setDestroySituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

successDisposition - success disposition for the new situation.

See Also:

Situation.setDestroySituation(String,String)

setFeatureSituation

public void setFeatureSituation(java.lang.String reasoningScope,
                                java.lang.String featureDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Feature Situation.

It also changes the 'categoryName' attribute to Situation.FEATURE_SITUATION_CATEGORY.

Specified by:

setFeatureSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

featureDisposition - feature disposition for the new situation.

See Also:

Situation.setFeatureSituation(String,String)

setOtherSituation

public void setOtherSituation(java.lang.String reasoningScope,
                              java.lang.String any)

Description copied from interface: Situation

Sets the value of the situation type as an Other Situation.

It also changes the 'categoryName' attribute to Situation.OTHER_SITUATION_CATEGORY.

Specified by:

setOtherSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

any - value for the new situation.

See Also:

Situation.setOtherSituation(String,String)

setReportSituation

public void setReportSituation(java.lang.String reasoningScope,
                               java.lang.String reportCategory)

Description copied from interface: Situation

Sets the value of the situation type as a Report Situation.

It also changes the 'categoryName' attribute to Situation.REPORT_SITUATION_CATEGORY.

Specified by:

setReportSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

reportCategory - report category for the new situation.

See Also:

Situation.setReportSituation(String,String)

setRequestSituation

public void setRequestSituation(java.lang.String reasoningScope,
                                java.lang.String situationQualifier,
                                java.lang.String successDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Request Situation.

It also changes the 'categoryName' attribute to Situation.REQUEST_SITUATION_CATEGORY.

Specified by:

setRequestSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

situationQualifier - situation qualifier for the new situation.

successDisposition - success disposition for the new situation.

See Also:

Situation.setRequestSituation(String, String,String)

setSituationType

public void setSituationType(SituationType newSituationType)

Description copied from interface: Situation

Sets the value of the ' Situation Type' containment reference.

Specified by:

setSituationType in interface Situation

Parameters:

newSituationType - the new value of the 'Situation Type' containment reference.

See Also:

Situation.getSituationType()

getSituationType

public SituationType getSituationType()

Description copied from interface: Situation

Returns the value of the 'Situation Type' containment reference.

Specified by:

getSituationType in interface Situation

Returns:

the value of the 'Situation Type' containment reference.

See Also:

Situation.setSituationType(SituationType)

setStartSituation

public void setStartSituation(java.lang.String reasoningScope,
                              java.lang.String situationQualifier,
                              java.lang.String successDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Start Situation.

It also changes the 'categoryName' attribute to Situation.START_SITUATION_CATEGORY.

Specified by:

setStartSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

situationQualifier - situation qualifier for the new situation.

successDisposition - sucess disposition for the new situation.

See Also:

Situation.setStartSituation(String, String,String)

setStopSituation

public void setStopSituation(java.lang.String reasoningScope,
                             java.lang.String situationQualifier,
                             java.lang.String successDisposition)

Description copied from interface: Situation

Sets the value of the situation type as a Stop Situation.

It also changes the 'categoryName' attribute to Situation.STOP_SITUATION_CATEGORY.

Specified by:

setStopSituation in interface Situation

Parameters:

reasoningScope - reasoning scope for the situation.

situationQualifier - situation qualifier for the new situation.

successDisposition - success disposition for the new situation.

See Also:

Situation.setStopSituation(String, String,String)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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 Situation

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.

Overrides:

equals in class java.lang.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.

Overrides:

clone in class java.lang.Object

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 Situation