Package org.apache.uima.collection
Interface EntityProcessStatus
- All Superinterfaces:
Serializable
Contains information about the successful or unsuccessful processing of an entity (an element of
a collection) by the
CollectionProcessingManager.-
Method Summary
Modifier and TypeMethodDescriptionGets the List of Exceptions that occurred during processing of the Entity.Gets the name of the components in which Exceptions (if any) occurred.Gets theProcessTraceobject for the Entity's processing.Gets a message describing the status of the Entity's processing.booleanGets whether an entity has beed skipped during processingbooleanGets whether an exception occurred.
-
Method Details
-
isException
boolean isException()Gets whether an exception occurred.- Returns:
- true if an exception occurred, false if processing completely successfully with no exceptions.
-
getStatusMessage
String getStatusMessage()Gets a message describing the status of the Entity's processing.- Returns:
- the status message
-
getExceptions
Gets the List of Exceptions that occurred during processing of the Entity.- Returns:
- the List of Exceptions,
nullif none
-
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,
nullif there was no failure
-
getProcessTrace
ProcessTrace getProcessTrace()Gets theProcessTraceobject for the Entity's processing. TheProcessTraceobject 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
-