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

Class ChunkMetadata

java.lang.Object

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

public class ChunkMetadata
extends 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

Fields

Modifier and Type	Field and Description
static String	DOCUMENTID The Constant DOCUMENTID.
static String	DOCUMENTURL The Constant DOCUMENTURL.
static String	ISCOMPLETED The Constant ISCOMPLETED.
static String	SEQUENCE The Constant SEQUENCE.
static String	THROTTLEID The Constant THROTTLEID.

Constructor Summary

Constructors

Constructor and Description
ChunkMetadata(String aDocId, int aSequence, boolean aLast) Instantiates a new chunk metadata.

Method Summary

Modifier and Type	Method and Description
String	getDocId() Gets the doc id.
int	getSequence() Gets the sequence.
String	getThrottleID() Gets the throttle ID.
String	getURL() Gets the url.
boolean	isLast() Checks if is last.
boolean	isOneOfMany() Checks if is one of many.
boolean	isTimedOut() Checks if is timed out.
void	setThrottleID(String aThrottleID) Sets the throttle ID.
void	setTimedOut(boolean b) Sets the timed out.
void	setURL(String aURL) Sets the url.

Methods inherited from class java.lang.Object

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

Field Detail

SEQUENCE

public static final String SEQUENCE

The Constant SEQUENCE.

See Also:

Constant Field Values

DOCUMENTID

public static final String DOCUMENTID

The Constant DOCUMENTID.

See Also:

Constant Field Values

ISCOMPLETED

public static final String ISCOMPLETED

The Constant ISCOMPLETED.

See Also:

Constant Field Values

DOCUMENTURL

public static final String DOCUMENTURL

The Constant DOCUMENTURL.

See Also:

Constant Field Values

THROTTLEID

public static final String THROTTLEID

The Constant THROTTLEID.

See Also:

Constant Field Values

Constructor Detail

ChunkMetadata

public ChunkMetadata(String aDocId,
                     int aSequence,
                     boolean aLast)

Instantiates a new chunk metadata.

Parameters:

aDocId - the a doc id

aSequence - the a sequence

aLast - the a last

Method Detail

isLast

public boolean isLast()

Checks if is last.

Returns:

true, if is last

getSequence

public int getSequence()

Gets the sequence.

Returns:

the sequence

isOneOfMany

public boolean isOneOfMany()

Checks if is one of many.

Returns:

true, if is one of many

getDocId

public String getDocId()

Gets the doc id.

Returns:

the doc id

getThrottleID

public String getThrottleID()

Gets the throttle ID.

Returns:

the throttle ID

getURL

public String getURL()

Gets the url.

Returns:

the url

isTimedOut

public boolean isTimedOut()

Checks if is timed out.

Returns:

true if timed out

setTimedOut

public void setTimedOut(boolean b)

Sets the timed out.

Parameters:

b - true means timed out

setThrottleID

public void setThrottleID(String aThrottleID)

Sets the throttle ID.

Parameters:

aThrottleID - the new throttle ID

setURL

public void setURL(String aURL)

Sets the url.

Parameters:

aURL - the new url