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

Class 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

      Fields 
      Modifier and Type Field Description
      private java.lang.String docId
      The doc id.
      static java.lang.String DOCUMENTID
      The Constant DOCUMENTID.
      static java.lang.String DOCUMENTURL
      The Constant DOCUMENTURL.
      static java.lang.String ISCOMPLETED
      The Constant ISCOMPLETED.
      private boolean last
      The last.
      private int sequence
      The sequence.
      static java.lang.String SEQUENCE
      The Constant SEQUENCE.
      private java.lang.String throttleID
      The throttle ID.
      static java.lang.String THROTTLEID
      The Constant THROTTLEID.
      private boolean timedOut
      The timed out.
      private java.lang.String url
      The url.

    • Constructor Summary

      Constructors 
      Constructor Description
      ChunkMetadata​(java.lang.String aDocId, int aSequence, boolean aLast)
      Instantiates a new chunk metadata.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDocId()
      Gets the doc id.
      int getSequence()
      Gets the sequence.
      java.lang.String getThrottleID()
      Gets the throttle ID.
      java.lang.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​(java.lang.String aThrottleID)
      Sets the throttle ID.
      void setTimedOut​(boolean b)
      Sets the timed out.
      void setURL​(java.lang.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 java.lang.String SEQUENCE
        The Constant SEQUENCE.
        See Also:
        Constant Field Values

      • DOCUMENTID

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

      • ISCOMPLETED

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

      • DOCUMENTURL

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

      • THROTTLEID

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

      • docId

        private java.lang.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 java.lang.String url
        The url.

      • throttleID

        private java.lang.String throttleID
        The throttle ID.

    • Constructor Detail

      • ChunkMetadata

        public ChunkMetadata​(java.lang.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 java.lang.String getDocId()
        Gets the doc id.
        Returns:
        the doc id

      • getThrottleID

        public java.lang.String getThrottleID()
        Gets the throttle ID.
        Returns:
        the throttle ID

      • getURL

        public java.lang.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​(java.lang.String aThrottleID)
        Sets the throttle ID.
        Parameters:
        aThrottleID - the new throttle ID

      • setURL

        public void setURL​(java.lang.String aURL)
        Sets the url.
        Parameters:
        aURL - the new url