TPTP 4.1.0 Platform Project
Public API Specification

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

java.lang.Object
  extended byorg.eclipse.tptp.logging.events.cbe.impl.ComponentIdentificationImpl
All Implemented Interfaces:
java.lang.Cloneable, ComponentIdentification, java.io.Serializable

public class ComponentIdentificationImpl
extends java.lang.Object
implements ComponentIdentification

Interface representing a ComponentIdentification.

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":

Component identification provides a collection of attributes that are required to uniquely identify a component. The same data is used to identify both the reporter and the affected component.

Since:
1.0.1
See Also:
Serialized Form

Field Summary
protected  java.lang.String application
          The cached value of the 'Application' attribute.
protected  java.lang.String component
          The cached value of the 'Component' attribute.
protected  java.lang.String componentIdType
          The cached value of the ' Component Id Type' attribute.
protected  java.lang.String componentType
          The cached value of the ' Component Type' attribute.
protected  java.lang.String executionEnvironment
          The cached value of the ' Execution Environment' attribute.
protected  java.lang.String instanceId
          The cached value of the 'Instance Id' attribute.
protected  java.lang.String location
          The cached value of the 'Location' attribute.
protected  java.lang.String locationType
          The cached value of the ' Location Type' attribute.
protected  java.lang.String processId
          The cached value of the 'Process Id' attribute.
protected  java.lang.String subComponent
          The cached value of the ' Sub Component' attribute.
protected  java.lang.String threadId
          The cached value of the 'Thread Id' attribute.
 
Fields inherited from interface org.eclipse.tptp.logging.events.cbe.ComponentIdentification
COMPONENT_ID_TYPE_APPLICATION, COMPONENT_ID_TYPE_DEVICE_NAME, COMPONENT_ID_TYPE_PROCESS, COMPONENT_ID_TYPE_PRODUCT_NAME, COMPONENT_ID_TYPE_SERVICE_NAME, COMPONENT_ID_TYPE_SYSTEM_NAME, COMPONENT_ID_TYPE_UNKNOWN, LOCATION_TYPE_DCC, LOCATION_TYPE_DEVICE_NAME, LOCATION_TYPE_DIAL, LOCATION_TYPE_E_164, LOCATION_TYPE_FQ_HOSTNAME, LOCATION_TYPE_HID, LOCATION_TYPE_HOSTNAME, LOCATION_TYPE_HWA, LOCATION_TYPE_ICD, LOCATION_TYPE_IPV4, LOCATION_TYPE_IPV6, LOCATION_TYPE_IPX, LOCATION_TYPE_ISDN, LOCATION_TYPE_NWA, LOCATION_TYPE_OID_OSI, LOCATION_TYPE_SNA, LOCATION_TYPE_UNKNOWN, LOCATION_TYPE_X25
 
Constructor Summary
protected ComponentIdentificationImpl()
           
 
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 getApplication()
           
 java.lang.String getComponent()
           
 java.lang.String getComponentIdType()
           
 java.lang.String getComponentType()
           
 java.lang.String getExecutionEnvironment()
           
 java.lang.String getInstanceId()
           
 java.lang.String getLocation()
           
 java.lang.String getLocationType()
           
 java.lang.String getProcessId()
           
 java.lang.String getSubComponent()
           
 java.lang.String getThreadId()
           
 void init()
          Resets the object's properties to their initial (e.g.
 void setApplication(java.lang.String newApplication)
           
 void setComponent(java.lang.String newComponent)
           
 void setComponentIdType(java.lang.String newComponentIdType)
           
 void setComponentType(java.lang.String newComponentType)
           
 void setExecutionEnvironment(java.lang.String newExecutionEnvironment)
           
 void setInstanceId(java.lang.String newInstanceId)
           
 void setLocation(java.lang.String newLocation)
           
 void setLocationType(java.lang.String newLocationType)
           
 void setProcessId(java.lang.String newProcessId)
           
 void setSubComponent(java.lang.String newSubComponent)
           
 void setThreadId(java.lang.String newThreadId)
           
 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

application

protected java.lang.String application
The cached value of the 'Application' attribute.

See Also:
getApplication()

component

protected java.lang.String component
The cached value of the 'Component' attribute.

See Also:
getComponent()

componentType

protected java.lang.String componentType
The cached value of the ' Component Type' attribute.

See Also:
getComponentType()

componentIdType

protected java.lang.String componentIdType
The cached value of the ' Component Id Type' attribute.

See Also:
getComponentIdType()

executionEnvironment

protected java.lang.String executionEnvironment
The cached value of the ' Execution Environment' attribute.

See Also:
getExecutionEnvironment()

instanceId

protected java.lang.String instanceId
The cached value of the 'Instance Id' attribute.

See Also:
getInstanceId()

location

protected java.lang.String location
The cached value of the 'Location' attribute.

See Also:
getLocation()

locationType

protected java.lang.String locationType
The cached value of the ' Location Type' attribute.

See Also:
getLocationType()

processId

protected java.lang.String processId
The cached value of the 'Process Id' attribute.

See Also:
getProcessId()

subComponent

protected java.lang.String subComponent
The cached value of the ' Sub Component' attribute.

See Also:
getSubComponent()

threadId

protected java.lang.String threadId
The cached value of the 'Thread Id' attribute.

See Also:
getThreadId()
Constructor Detail

ComponentIdentificationImpl

protected ComponentIdentificationImpl()

Method Detail

setApplication

public void setApplication(java.lang.String newApplication)

Specified by:
setApplication in interface ComponentIdentification
Parameters:
newApplication - the new value of the 'Application' attribute.
See Also:
ComponentIdentification.getApplication()

getApplication

public java.lang.String getApplication()

Specified by:
getApplication in interface ComponentIdentification
Returns:
the value of the 'Application' attribute.
See Also:
ComponentIdentification.setApplication(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_Application()

setComponent

public void setComponent(java.lang.String newComponent)

Specified by:
setComponent in interface ComponentIdentification
Parameters:
newComponent - the new value of the 'Component' attribute.
See Also:
ComponentIdentification.getComponent()

getComponent

public java.lang.String getComponent()

Specified by:
getComponent in interface ComponentIdentification
Returns:
the value of the 'Component' attribute.
See Also:
ComponentIdentification.setComponent(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_Component()

setComponentIdType

public void setComponentIdType(java.lang.String newComponentIdType)

Specified by:
setComponentIdType in interface ComponentIdentification
Parameters:
newComponentIdType - the new value of the 'Component Id Type' attribute.
See Also:
ComponentIdentification.getComponentIdType()

getComponentIdType

public java.lang.String getComponentIdType()

Specified by:
getComponentIdType in interface ComponentIdentification
Returns:
the value of the 'Component Id Type' attribute.
See Also:
ComponentIdentification.setComponentIdType(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_ComponentIdType()

setComponentType

public void setComponentType(java.lang.String newComponentType)

Specified by:
setComponentType in interface ComponentIdentification
Parameters:
newComponentType - the new value of the 'Component Type' attribute.
See Also:
ComponentIdentification.getComponentType()

getComponentType

public java.lang.String getComponentType()

Specified by:
getComponentType in interface ComponentIdentification
Returns:
the value of the 'Component Type' attribute.
See Also:
ComponentIdentification.setComponentType(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_ComponentType()

setExecutionEnvironment

public void setExecutionEnvironment(java.lang.String newExecutionEnvironment)

Specified by:
setExecutionEnvironment in interface ComponentIdentification
Parameters:
newExecutionEnvironment - the new value of the 'Execution Environment' attribute.
See Also:
ComponentIdentification.getExecutionEnvironment()

getExecutionEnvironment

public java.lang.String getExecutionEnvironment()

Specified by:
getExecutionEnvironment in interface ComponentIdentification
Returns:
the value of the 'Execution Environment' attribute.
See Also:
ComponentIdentification.setExecutionEnvironment(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_ExecutionEnvironment()

setInstanceId

public void setInstanceId(java.lang.String newInstanceId)

Specified by:
setInstanceId in interface ComponentIdentification
Parameters:
newInstanceId - the new value of the 'Instance Id' attribute.
See Also:
ComponentIdentification.getInstanceId()

getInstanceId

public java.lang.String getInstanceId()

Specified by:
getInstanceId in interface ComponentIdentification
Returns:
the value of the 'Instance Id' attribute.
See Also:
ComponentIdentification.setInstanceId(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_InstanceId()

setLocation

public void setLocation(java.lang.String newLocation)

Specified by:
setLocation in interface ComponentIdentification
Parameters:
newLocation - the new value of the 'Location' attribute.
See Also:
ComponentIdentification.getLocation()

getLocation

public java.lang.String getLocation()

Specified by:
getLocation in interface ComponentIdentification
Returns:
the value of the 'Location' attribute.
See Also:
ComponentIdentification.setLocation(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_Location()

setLocationType

public void setLocationType(java.lang.String newLocationType)

Specified by:
setLocationType in interface ComponentIdentification
Parameters:
newLocationType - the new value of the 'Location Type' attribute.
See Also:
ComponentIdentification.getLocationType()

getLocationType

public java.lang.String getLocationType()

Specified by:
getLocationType in interface ComponentIdentification
Returns:
the value of the 'Location Type' attribute.
See Also:
ComponentIdentification.setLocationType(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_LocationType()

setProcessId

public void setProcessId(java.lang.String newProcessId)

Specified by:
setProcessId in interface ComponentIdentification
Parameters:
newProcessId - the new value of the 'Process Id' attribute.
See Also:
ComponentIdentification.getProcessId()

getProcessId

public java.lang.String getProcessId()

Specified by:
getProcessId in interface ComponentIdentification
Returns:
the value of the 'Process Id' attribute.
See Also:
ComponentIdentification.setProcessId(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_ProcessId()

setSubComponent

public void setSubComponent(java.lang.String newSubComponent)

Specified by:
setSubComponent in interface ComponentIdentification
Parameters:
newSubComponent - the new value of the 'Sub Component' attribute.
See Also:
ComponentIdentification.getSubComponent()

getSubComponent

public java.lang.String getSubComponent()

Specified by:
getSubComponent in interface ComponentIdentification
Returns:
the value of the 'Sub Component' attribute.
See Also:
ComponentIdentification.setSubComponent(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_SubComponent()

setThreadId

public void setThreadId(java.lang.String newThreadId)

Specified by:
setThreadId in interface ComponentIdentification
Parameters:
newThreadId - the new value of the 'Thread Id' attribute.
See Also:
ComponentIdentification.getThreadId()

getThreadId

public java.lang.String getThreadId()

Specified by:
getThreadId in interface ComponentIdentification
Returns:
the value of the 'Thread Id' attribute.
See Also:
ComponentIdentification.setThreadId(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getComponentIdentification_ThreadId()

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 ComponentIdentification
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. All components are initialized to either zero or null.

Specified by:
init in interface ComponentIdentification
Since:
1.0

TPTP 4.1.0 Platform Project
Public API Specification