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 Details

    • SEQUENCE

      public static final String SEQUENCE
      The Constant SEQUENCE.
      See Also:
    • DOCUMENTID

      public static final String DOCUMENTID
      The Constant DOCUMENTID.
      See Also:
    • ISCOMPLETED

      public static final String ISCOMPLETED
      The Constant ISCOMPLETED.
      See Also:
    • DOCUMENTURL

      public static final String DOCUMENTURL
      The Constant DOCUMENTURL.
      See Also:
    • THROTTLEID

      public static final String THROTTLEID
      The Constant THROTTLEID.
      See Also:
    • docId

      private String docId
      The doc id.
    • sequence

      private int sequence
      The sequence.
    • last

      private boolean last
      The last.
    • timedOut

      private boolean timedOut
      The timed out.
    • url

      private String url
      The url.
    • throttleID

      private String throttleID
      The throttle ID.
  • Constructor Details

    • 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 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

      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