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

java.lang.Object
  extended by org.apache.uima.collection.impl.cpm.utils.ChunkMetadata

public class ChunkMetadata
extends java.lang.Object

Convenience class that is used to hold metadata associated with chunking and sequencing of documents. It allows the OutputQueue to manage sequencing of chunks destined for the CasConsumer.


Field Summary
static java.lang.String DOCUMENTID
           
static java.lang.String DOCUMENTURL
           
static java.lang.String ISCOMPLETED
           
static java.lang.String SEQUENCE
           
static java.lang.String THROTTLEID
           
 
Constructor Summary
ChunkMetadata(java.lang.String aDocId, int aSequence, boolean aLast)
           
 
Method Summary
 java.lang.String getDocId()
           
 int getSequence()
           
 java.lang.String getThrottleID()
           
 java.lang.String getURL()
           
 boolean isLast()
           
 boolean isOneOfMany()
           
 boolean isTimedOut()
           
 void setThrottleID(java.lang.String aThrottleID)
           
 void setTimedOut(boolean b)
           
 void setURL(java.lang.String aURL)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEQUENCE

public static final java.lang.String SEQUENCE
See Also:
Constant Field Values

DOCUMENTID

public static final java.lang.String DOCUMENTID
See Also:
Constant Field Values

ISCOMPLETED

public static final java.lang.String ISCOMPLETED
See Also:
Constant Field Values

DOCUMENTURL

public static final java.lang.String DOCUMENTURL
See Also:
Constant Field Values

THROTTLEID

public static final java.lang.String THROTTLEID
See Also:
Constant Field Values
Constructor Detail

ChunkMetadata

public ChunkMetadata(java.lang.String aDocId,
                     int aSequence,
                     boolean aLast)
Method Detail

isLast

public boolean isLast()

getSequence

public int getSequence()

isOneOfMany

public boolean isOneOfMany()

getDocId

public java.lang.String getDocId()

getThrottleID

public java.lang.String getThrottleID()

getURL

public java.lang.String getURL()

isTimedOut

public boolean isTimedOut()
Returns:

setTimedOut

public void setTimedOut(boolean b)
Parameters:
b -

setThrottleID

public void setThrottleID(java.lang.String aThrottleID)

setURL

public void setURL(java.lang.String aURL)


Copyright © 2010 The Apache Software Foundation. All Rights Reserved.