Package org.apache.uima.collection.impl
Class EntityProcessStatusImpl
- java.lang.Object
-
- org.apache.uima.collection.impl.EntityProcessStatusImpl
-
- All Implemented Interfaces:
Serializable
,EntityProcessStatus
public class EntityProcessStatusImpl extends Object implements EntityProcessStatus
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description boolean
isProcessed
-
Constructor Summary
Constructors Constructor Description EntityProcessStatusImpl(ProcessTrace p)
EntityProcessStatusImpl(ProcessTrace p, boolean aSkip)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addEventStatus(String aEventName, String aResultS, Throwable aE)
List
getExceptions()
Gets the List of Exceptions that occurred during processing of the Entity.List
getFailedComponentNames()
Gets the name of the components in which Exceptions (if any) occurred.ProcessTrace
getProcessTrace()
Gets theProcessTrace
object for the Entity's processing.String
getStatusMessage()
Gets a message describing the status of the Entity's processing.boolean
isEntitySkipped()
Gets whether an entity has beed skipped during processingboolean
isException()
Gets whether an exception occurred.void
printEventLog()
-
-
-
Constructor Detail
-
EntityProcessStatusImpl
public EntityProcessStatusImpl(ProcessTrace p)
-
EntityProcessStatusImpl
public EntityProcessStatusImpl(ProcessTrace p, boolean aSkip)
-
-
Method Detail
-
isException
public boolean isException()
Description copied from interface:EntityProcessStatus
Gets whether an exception occurred.- Specified by:
isException
in interfaceEntityProcessStatus
- Returns:
- true if an exception occurred, false if processing completely successfully with no exceptions.
-
getStatusMessage
public String getStatusMessage()
Description copied from interface:EntityProcessStatus
Gets a message describing the status of the Entity's processing.- Specified by:
getStatusMessage
in interfaceEntityProcessStatus
- Returns:
- the status message
-
getExceptions
public List getExceptions()
Description copied from interface:EntityProcessStatus
Gets the List of Exceptions that occurred during processing of the Entity.- Specified by:
getExceptions
in interfaceEntityProcessStatus
- Returns:
- the List of Exceptions,
null
if none
-
getFailedComponentNames
public List getFailedComponentNames()
Description copied from interface:EntityProcessStatus
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.- Specified by:
getFailedComponentNames
in interfaceEntityProcessStatus
- Returns:
- the name of the components that failed,
null
if there was no failure
-
getProcessTrace
public ProcessTrace getProcessTrace()
Description copied from interface:EntityProcessStatus
Gets theProcessTrace
object for the Entity's processing. TheProcessTrace
object contains a record of each component involved in the processing and how much time that component took to complete its processing.- Specified by:
getProcessTrace
in interfaceEntityProcessStatus
- Returns:
- the object containing trace and timing information for the Entity's processing.
-
printEventLog
public void printEventLog()
-
isEntitySkipped
public boolean isEntitySkipped()
Gets whether an entity has beed skipped during processing- Specified by:
isEntitySkipped
in interfaceEntityProcessStatus
- Returns:
- true if an entity was skipped, false otherwise
-
-