Class PageGroup

  • All Implemented Interfaces:
    Completable, Streamable

    public class PageGroup
    extends AbstractResourceEnvironmentGroupContainer
    A page group is used in the data stream to define a named, logical grouping of sequential pages. Page groups are delimited by begin-end structured fields that carry the name of the page group. Page groups are defined so that the pages that comprise the group can be referenced or processed as a single entity. Page groups are often processed in stand-alone fashion; that is, they are indexed, retrieved, and presented outside the context of the containing document.
    • Constructor Detail

      • PageGroup

        public PageGroup​(Factory factory,
                         java.lang.String name)
        Constructor for the PageGroup.
        Parameters:
        factory - the resource manager
        name - the name of the page group
    • Method Detail

      • endPageGroup

        public void endPageGroup()
        Method to mark the end of the page group.
      • writeStart

        protected void writeStart​(java.io.OutputStream os)
                           throws java.io.IOException
        Helper method to write the start of the Object.
        Overrides:
        writeStart in class AbstractStructuredObject
        Parameters:
        os - The stream to write to
        Throws:
        java.io.IOException - throws an I/O exception if one occurred
      • writeEnd

        protected void writeEnd​(java.io.OutputStream os)
                         throws java.io.IOException
        Helper method to write the end of the Object.
        Overrides:
        writeEnd in class AbstractStructuredObject
        Parameters:
        os - The stream to write to
        Throws:
        java.io.IOException - an I/O exception if one occurred