Class PageSegmentHandle

    • Constructor Detail

      • PageSegmentHandle

        public PageSegmentHandle()
    • Method Detail

      • init

        public void init​(String documentLayer,
                         int pageIndex,
                         String pageSegmentUUID)
        Provide the PageSegmentHandle with its payload data to uniquely identify it.
        Parameters:
        documentLayer - The layer this PageSegment is associated with
        pageIndex - The index of the page. Regardless of whether this is a "standard" or a composite document this is always the absolute page index relative to page 0 of the very first document.
        pageSegmentUUID - The unique key of this PageSegment
      • getPageIndex

        public int getPageIndex()
        Gets the index of the page containing the PageSegment.
        Returns:
        The 0-based page index of this PageSegment.
      • setPageIndex

        public void setPageIndex​(int pageIndex)
        Sets the index of the page containing the PageSegment.
        Parameters:
        pageIndex - The 0-based page index of this PageSegment.
      • getPageSegmentUUID

        public String getPageSegmentUUID()
        Gets the UUID for caching the PageSegment.
        Returns:
        pageSegmentUUID The page segment's unique identifier.
      • setPageSegmentUUID

        public void setPageSegmentUUID​(String pageSegmentUUID)
        Sets the UUID for caching the PageSegment.
        Parameters:
        pageSegmentUUID - The page segment's unique identifier.
      • getIdentifier

        public abstract String getIdentifier()
        Creates a "DocumentID" to be able to cache the Jadice document on recovering. NOTE: The Identifier represents the ID of the Document, not the PageSegment!
        Returns:
        The unique DocumentID of the document associated with this PageSegment.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object