Package org.apache.uima.util.impl

Class ProcessTraceEvent_impl

    • Constructor Summary

      Constructors 
      Constructor Description
      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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addSubEvent​(ProcessTraceEvent aEvent)  
      void addToDuration​(long aAdditionalDuration)  
      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)  
      void setDescription​(java.lang.String aDescription)  
      void setDuration​(int aDuration)  
      void setResultMessage​(java.lang.String aResultMessage)  
      void setStartTime​(long aStartTime)  
      void setType​(java.lang.String aType)  
      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

      • setComponentName

        public void setComponentName​(java.lang.String aName)
        Parameters:
        aName - 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)
        Parameters:
        aType - the type of this event

      • setDescription

        public void setDescription​(java.lang.String aDescription)
        Parameters:
        aDescription - the description for this event

      • setDuration

        public void setDuration​(int aDuration)
        Parameters:
        aDuration - the duration for this event

      • addToDuration

        public void addToDuration​(long aAdditionalDuration)
        Parameters:
        aAdditionalDuration - Adds this to the duration of this event

      • setResultMessage

        public void setResultMessage​(java.lang.String aResultMessage)
        Parameters:
        aResultMessage - the Result Message for this event

      • addSubEvent

        public void addSubEvent​(ProcessTraceEvent aEvent)
        Parameters:
        aEvent - Adds this 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)

      • 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