org.apache.uima.collection.impl.cpm.utils

Class QueueEntity

java.lang.Object

org.apache.uima.collection.impl.cpm.utils.QueueEntity

public class QueueEntity
extends Object

Convenience wrapper that is internally used by the CPM. Created in the OutputQueue this wrapper contains the CAS and additional information needed to determine if the CAS contained has arrived later than expected Normally the CAS would be marked as NOT timed out. In case of chunking, the CAS may come after a timeout occurs. In this case the CPM needs to know this and take appropriate action.

Constructor Summary

Constructors

Constructor and Description
QueueEntity(Object anEntity, boolean hasTimedOut) Initialize the instance with the Entity (CAS) and the timeout.

Method Summary

Modifier and Type	Method and Description
Object	getEntity() Gets the entity.
boolean	isTimedOut() Checks if is timed out.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueEntity

public QueueEntity(Object anEntity,
                   boolean hasTimedOut)

Initialize the instance with the Entity (CAS) and the timeout.

Parameters:

anEntity - the an entity

hasTimedOut - the has timed out

Method Detail

getEntity

public Object getEntity()

Gets the entity.

Returns:

the entity

isTimedOut

public boolean isTimedOut()

Checks if is timed out.

Returns:

true if timed out