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 and Description
boolean	isProcessed

Constructor Summary

Constructors

Constructor and Description
EntityProcessStatusImpl(ProcessTrace p)
EntityProcessStatusImpl(ProcessTrace p, boolean aSkip)

Method Summary

Modifier and Type	Method and 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 the ProcessTrace 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 processing
boolean	isException() Gets whether an exception occurred.
void	printEventLog()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isProcessed

public boolean isProcessed

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 interface EntityProcessStatus

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 interface EntityProcessStatus

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 interface EntityProcessStatus

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 interface EntityProcessStatus

Returns:

the name of the components that failed, null if there was no failure

addEventStatus

public void addEventStatus(String aEventName,
                           String aResultS,
                           Throwable aE)

getProcessTrace

public ProcessTrace getProcessTrace()

Description copied from interface: EntityProcessStatus

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.

Specified by:

getProcessTrace in interface EntityProcessStatus

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 interface EntityProcessStatus

Returns:

true if an entity was skipped, false otherwise