Package org.apache.uima.collection

Interface EntityProcessStatus

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    EntityProcessStatusImpl
    public interface EntityProcessStatus
extends java.io.Serializable
    Contains information about the successful or unsuccessful processing of an entity (an element of a collection) by the CollectionProcessingManager.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.Exception> getExceptions()
      Gets the List of Exceptions that occurred during processing of the Entity.
      java.util.List<java.lang.String> getFailedComponentNames()
      Gets the name of the components in which Exceptions (if any) occurred.
      ProcessTrace getProcessTrace()
      Gets the ProcessTrace object for the Entity's processing.
      java.lang.String getStatusMessage()
      Gets a message describing the status of the Entity's processing.
      boolean isEntitySkipped()
      Gets whether an entity has beed skipped during processing
      boolean isException()
      Gets whether an exception occurred.

    • Method Detail

      • isException

        boolean isException()
        Gets whether an exception occurred.
        Returns:
        true if an exception occurred, false if processing completely successfully with no exceptions.

      • getStatusMessage

        java.lang.String getStatusMessage()
        Gets a message describing the status of the Entity's processing.
        Returns:
        the status message

      • getExceptions

        java.util.List<java.lang.Exception> getExceptions()
        Gets the List of Exceptions that occurred during processing of the Entity.
        Returns:
        the List of Exceptions, null if none

      • getFailedComponentNames

        java.util.List<java.lang.String> getFailedComponentNames()
        Gets the name of the components in which Exceptions (if any) occurred. These could be the Analysis Engine or one or more of the CasConsumers.
        Returns:
        the name of the components that failed, null if there was no failure

      • getProcessTrace

        ProcessTrace getProcessTrace()
        Gets the ProcessTrace object for the Entity's processing. The ProcessTrace object contains a record of each component involved in the processing and how much time that component took to complete its processing.
        Returns:
        the object containing trace and timing information for the Entity's processing.

      • isEntitySkipped

        boolean isEntitySkipped()
        Gets whether an entity has beed skipped during processing
        Returns:
        true if an entity was skipped, false otherwise