org.apache.uima.util.impl
Class ProcessTraceEvent_impl

java.lang.Object
  extended by org.apache.uima.util.impl.ProcessTraceEvent_impl
All Implemented Interfaces:
java.io.Serializable, ProcessTraceEvent

public class ProcessTraceEvent_impl
extends java.lang.Object
implements ProcessTraceEvent

Reference implementation of ProcessTraceEvent.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.apache.uima.util.ProcessTraceEvent
ANALYSIS, ANALYSIS_ENGINE, SERVICE, SERVICE_CALL
 
Constructor Summary
ProcessTraceEvent_impl()
          Creates a new ProcessTraceEvent_impl with null property values.
ProcessTraceEvent_impl(java.lang.String aComponentName, java.lang.String aType, java.lang.String aDescription)
          Creates a new ProcessTraceEvent_impl and sets the Component name, type, and description properties.
 
Method Summary
 void addSubEvent(ProcessTraceEvent aEvent)
          Adds a sub-event to this event.
 void addToDuration(long aAdditionalDuration)
          Adds to the duration of this event
 java.lang.String getComponentName()
          Retrieves the name of the component that is performing this event.
 java.lang.String getDescription()
          Retrieves the description of this event.
 int getDuration()
          Gets the duration of this event.
 int getDurationExcludingSubEvents()
          Gets the duration of this event, minus the sum of the durations of its direct sub-events.
 java.lang.String getResultMessage()
          Retrieves the result message of this event.
 long getStartTime()
           
 java.util.List<ProcessTraceEvent> getSubEvents()
          Gets the sub-events of this event.
 java.lang.String getType()
          Gets the type of event.
 void setComponentName(java.lang.String aName)
          Sets the component name for this event
 void setDescription(java.lang.String aDescription)
          Sets the description for this event
 void setDuration(int aDuration)
          Sets the duration for this event
 void setResultMessage(java.lang.String aResultMessage)
          Sets the Result Message for this event
 void setStartTime(long aStartTime)
           
 void setType(java.lang.String aType)
          Sets the type of this event
 java.lang.String toString()
          Generates a user-readable representation of this event and its sub-events.
 void toString(java.lang.StringBuffer aBuf, int aIndentLevel)
          Generates a user-readable representation of this event and its subevents, using the given indentation level and writing to a StringBuffer.
 void toString(java.lang.StringBuffer aBuf, int aIndentLevel, int aTotalTime)
          Generates a user-readable representation of this event and its subevents, using the given indentation level and writing to a StringBuffer.
protected  void writeTabs(int aNumTabs, java.lang.StringBuffer aBuf)
          Writes tabs to a StringBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProcessTraceEvent_impl

public ProcessTraceEvent_impl()
Creates a new ProcessTraceEvent_impl with null property values.


ProcessTraceEvent_impl

public ProcessTraceEvent_impl(java.lang.String aComponentName,
                              java.lang.String aType,
                              java.lang.String aDescription)
Creates a new ProcessTraceEvent_impl and sets the Component name, type, and description properties.

Parameters:
aComponentName - name of Component generating this event
aType - type of event. Standard event types are defined as constants on the ProcessTraceEvent interface, but any string is allowed.
aDescription - description of event
Method Detail

getComponentName

public java.lang.String getComponentName()
Description copied from interface: ProcessTraceEvent
Retrieves the name of the component that is performing this event.

Specified by:
getComponentName in interface ProcessTraceEvent
Returns:
the component name
See Also:
ProcessTraceEvent.getComponentName()

setComponentName

public void setComponentName(java.lang.String aName)
Sets the component name for this event


getType

public java.lang.String getType()
Description copied from interface: ProcessTraceEvent
Gets the type of event. Standard values for this property are defined as constants on this interface, but any String is allowed.

Specified by:
getType in interface ProcessTraceEvent
Returns:
the event type
See Also:
ProcessTraceEvent.getType()

setType

public void setType(java.lang.String aType)
Sets the type of this event


getDescription

public java.lang.String getDescription()
Description copied from interface: ProcessTraceEvent
Retrieves the description of this event.

Specified by:
getDescription in interface ProcessTraceEvent
Returns:
the event Description
See Also:
ProcessTraceEvent.getDescription()

setDescription

public void setDescription(java.lang.String aDescription)
Sets the description for this event


getDuration

public int getDuration()
Description copied from interface: ProcessTraceEvent
Gets the duration of this event.

Specified by:
getDuration in interface ProcessTraceEvent
Returns:
the duration of this event, in milliseconds.
See Also:
ProcessTraceEvent.getDuration()

setDuration

public void setDuration(int aDuration)
Sets the duration for this event


addToDuration

public void addToDuration(long aAdditionalDuration)
Adds to the duration of this event


getResultMessage

public java.lang.String getResultMessage()
Description copied from interface: ProcessTraceEvent
Retrieves the result message of this event.

Specified by:
getResultMessage in interface ProcessTraceEvent
Returns:
the event's result message
See Also:
ProcessTraceEvent.getResultMessage()

setResultMessage

public void setResultMessage(java.lang.String aResultMessage)
Sets the Result Message for this event


getSubEvents

public java.util.List<ProcessTraceEvent> getSubEvents()
Description copied from interface: ProcessTraceEvent
Gets the sub-events of this event.

Specified by:
getSubEvents in interface ProcessTraceEvent
Returns:
a List containing other ProcessTraceEvent objects
See Also:
ProcessTraceEvent.getSubEvents()

addSubEvent

public void addSubEvent(ProcessTraceEvent aEvent)
Adds a sub-event to this event.


toString

public java.lang.String toString()
Description copied from interface: ProcessTraceEvent
Generates a user-readable representation of this event and its sub-events.

Specified by:
toString in interface ProcessTraceEvent
Overrides:
toString in class java.lang.Object
Returns:
the String representation of this event and its sub-events
See Also:
ProcessTraceEvent.toString()

toString

public void toString(java.lang.StringBuffer aBuf,
                     int aIndentLevel)
Description copied from interface: ProcessTraceEvent
Generates a user-readable representation of this event and its subevents, using the given indentation level and writing to a StringBuffer. This is useful for writing nested events.

Specified by:
toString in interface ProcessTraceEvent
Parameters:
aBuf - string buffer to add to
aIndentLevel - indentation level
See Also:
ProcessTraceEvent.toString(StringBuffer,int)

toString

public void toString(java.lang.StringBuffer aBuf,
                     int aIndentLevel,
                     int aTotalTime)
Description copied from interface: ProcessTraceEvent
Generates a user-readable representation of this event and its subevents, using the given indentation level and writing to a StringBuffer. Also, if the total time for all events is known, this method will print the percentage of time used by this event and its subevents.

Specified by:
toString in interface ProcessTraceEvent
Parameters:
aBuf - string buffer to add to
aIndentLevel - indentation level
aTotalTime - total time, used to calculate percentags. If not known, pass 0.
See Also:
ProcessTraceEvent.toString(java.lang.StringBuffer, int, int)

getDurationExcludingSubEvents

public int getDurationExcludingSubEvents()
Description copied from interface: ProcessTraceEvent
Gets the duration of this event, minus the sum of the durations of its direct sub-events.

Specified by:
getDurationExcludingSubEvents in interface ProcessTraceEvent
Returns:
the duration of this event in milliseconds, excluding the time spent in its sub-events
See Also:
ProcessTraceEvent.getDurationExcludingSubEvents()

getStartTime

public long getStartTime()

setStartTime

public void setStartTime(long aStartTime)

writeTabs

protected void writeTabs(int aNumTabs,
                         java.lang.StringBuffer aBuf)
Writes tabs to a StringBuffer

Parameters:
aNumTabs - number of tabs to print
aBuf - the buffer to write to


Copyright © 2011. All Rights Reserved.