Class ChunkMetadata
java.lang.Object
org.apache.uima.collection.impl.cpm.utils.ChunkMetadata
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
FieldsModifier and TypeFieldDescriptionprivate String
The doc id.static final String
The Constant DOCUMENTID.static final String
The Constant DOCUMENTURL.static final String
The Constant ISCOMPLETED.private boolean
The last.private int
The sequence.static final String
The Constant SEQUENCE.private String
The throttle ID.static final String
The Constant THROTTLEID.private boolean
The timed out.private String
The url. -
Constructor Summary
ConstructorsConstructorDescriptionChunkMetadata
(String aDocId, int aSequence, boolean aLast) Instantiates a new chunk metadata. -
Method Summary
Modifier and TypeMethodDescriptiongetDocId()
Gets the doc id.int
Gets the sequence.Gets the throttle ID.getURL()
Gets the url.boolean
isLast()
Checks if is last.boolean
Checks if is one of many.boolean
Checks if is timed out.void
setThrottleID
(String aThrottleID) Sets the throttle ID.void
setTimedOut
(boolean b) Sets the timed out.void
Sets the url.
-
Field Details
-
SEQUENCE
The Constant SEQUENCE.- See Also:
-
DOCUMENTID
The Constant DOCUMENTID.- See Also:
-
ISCOMPLETED
The Constant ISCOMPLETED.- See Also:
-
DOCUMENTURL
The Constant DOCUMENTURL.- See Also:
-
THROTTLEID
The Constant THROTTLEID.- See Also:
-
docId
The doc id. -
sequence
private int sequenceThe sequence. -
last
private boolean lastThe last. -
timedOut
private boolean timedOutThe timed out. -
url
The url. -
throttleID
The throttle ID.
-
-
Constructor Details
-
ChunkMetadata
Instantiates a new chunk metadata.- Parameters:
aDocId
- the a doc idaSequence
- the a sequenceaLast
- the a last
-
-
Method Details
-
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
Gets the doc id.- Returns:
- the doc id
-
getThrottleID
Gets the throttle ID.- Returns:
- the throttle ID
-
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
Sets the throttle ID.- Parameters:
aThrottleID
- the new throttle ID
-
setURL
Sets the url.- Parameters:
aURL
- the new url
-