Package net.webpdf.parameter.schema.extraction.info

Class InformationType

  • public class InformationType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Summarizes structural information and settings for the PDF document.</p>

    Java class for InformationType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="InformationType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://schema.webpdf.de/1.0/extraction/info}DescriptionType"/>
         <element name="pdfa" type="{http://schema.webpdf.de/1.0/extraction/info}PdfaType"/>
         <element name="viewerPreferences" type="{http://schema.webpdf.de/1.0/extraction/info}ViewerPreferencesType"/>
       </sequence>
       <attribute name="objectKey" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="fileSize" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}long">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="initialPage" type="{http://www.w3.org/2001/XMLSchema}int" default="1" />
       <attribute name="language" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="pageLayout" type="{http://schema.webpdf.de/1.0/extraction/info}PageLayoutType" default="singlePage" />
       <attribute name="magnification" type="{http://schema.webpdf.de/1.0/extraction/info}MagnificationType" default="fitVisible" />
       <attribute name="magnificationZoom" default="100">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="initialView" type="{http://schema.webpdf.de/1.0/extraction/info}InitialViewType" default="none" />
       <attribute name="encrypted" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="portfolio" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="pages" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="attachments" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="formType" type="{http://schema.webpdf.de/1.0/extraction/info}FormsFormatType" default="none" />
       <attribute name="signatures" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="docMDP" type="{http://schema.webpdf.de/1.0/extraction/info}DocMdpType" default="none" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • objectKey

        protected String objectKey
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the document's catalog. (root)</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>

      • version

        protected String version
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The version name of the PDF standard the document claims compatibility with.</p>

      • fileSize

        protected Long fileSize
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The byte size of the document.</p>

      • initialPage

        protected Integer initialPage
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The first page, that shall be displayed when opening the document in a PDF Reader.</p>

      • language

        protected String language
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The natural language of the document. This could either contain the language name or a language tag.</p>

      • pageLayout

        protected PageLayoutType pageLayout
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The set initial page layout of the document. When opening the document in a Reader, this layout shall be selected to display pages.
                         <ul><li>singlePage = One page at a time.</li><li>oneColumn = One continuous column of pages.</li><li>twoColumnLeft = The pages in two columns, with odd
                                 <li>numbered pages on the left.</li></li><li>twoColumnRight = The pages in two columns, with odd
                                 <li>numbered pages on the right.</li></li><li>twoPageLeft = Display the pages two at a time, with odd
                                 <li>numbered pages on the left.</li></li><li>twoPageRight = Display the pages two at a time, with odd
                                 <li>numbered pages on the right.</li></li></ul></p>

      • magnification

        protected MagnificationType magnification
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The initial page zoom settings of the document. When opening the document in a Reader, this zoom settings shall be used.
                         <ul><li>none = Uses the application's default view.</li><li>fitWidth = Page width.</li><li>fitPage = Page dimensions.</li><li>fitHeight = Page height.</li><li>fitVisible = Page content width.</li><li>fitActual = Uses the original page dimensions (100% zoom factor).</li><li>zoom = Sets an explicit magnification value.</li></ul></p>

      • magnificationZoom

        protected Integer magnificationZoom
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If a magnification "zoom" is selected for this document, this is the actual percentage the pages of the document shall be zoomed to, when opening the document in a PDF Reader.</p>

      • initialView

        protected InitialViewType initialView
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines which sub
                         <li>windows will be opened when the PDF document is opened.</li><ul><li>none = No special view</li><li>outlines = Opens the "Bookmarks" tab</li><li>thumbnails = Opens the "Thumbnails" tab</li><li>fullscreen = Opens the document in full screen mode</li></ul></p>

      • encrypted

        protected Boolean encrypted
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">This will be set to "true" for a document, that is either password protected or certificate encrypted.</p>

      • portfolio

        protected Boolean portfolio
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Will be set to "true" for a "PDF collection" (Portfolio), that serves as the container for other documents.</p>

      • pages

        protected Integer pages
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of pages contained in the document.</p>

      • attachments

        protected Integer attachments
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of attachments contained in the document.</p>

      • formType

        protected FormsFormatType formType
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to another value than "none", the document does contain a PDF form in the hereby given format.
                         <ul><li>none = The document does not contain a form.</li><li>acroForm = The document contains a standard PDF Acroform.</li><li>staticXFA = The document contains a "XML Forms Architecture" form with a fixed layout (static).</li><li>dynamicXFA = The document contains a "XML Forms Architecture" form with an adaptable/interactive layout (dynamic).</li></ul></p>

      • signatures

        protected Integer signatures
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of signatures contained in the document.</p>

      • docMDP

        protected DocMdpType docMDP
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">A document "Modification Detection and Prevention" may be set, that defines which modifications of the document are allowed and which modifications would render the signature invalid.
                         <ul><li>none = The document is unprotected</li><li>modify it as you please.</li><li>noChangesAllowed = Any modifications of the document would render the signatures invalid.</li><li>formFillingSignatures = You may fill in forms and further sign the document.</li><li>formFillingSignaturesAndAnnotations = Form filling, signing and adding annotations are allowed.</li></ul></p>

    • Constructor Detail

      • InformationType

        public InformationType()

    • Method Detail

      • setDescription

        public void setDescription​(DescriptionType value)
        Sets the value of the description property.
        Parameters:
        value - allowed object is DescriptionType

      • getPdfa

        public PdfaType getPdfa()
        Gets the value of the pdfa property.
        Returns:
        possible object is PdfaType

      • setPdfa

        public void setPdfa​(PdfaType value)
        Sets the value of the pdfa property.
        Parameters:
        value - allowed object is PdfaType

      • getObjectKey

        public String getObjectKey()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the document's catalog. (root)</p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>
        Returns:
        possible object is String

      • setObjectKey

        public void setObjectKey​(String value)
        Sets the value of the objectKey property.
        Parameters:
        value - allowed object is String
        See Also:
        getObjectKey()

      • getVersion

        public String getVersion()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The version name of the PDF standard the document claims compatibility with.</p>
        Returns:
        possible object is String

      • setVersion

        public void setVersion​(String value)
        Sets the value of the version property.
        Parameters:
        value - allowed object is String
        See Also:
        getVersion()

      • getFileSize

        public long getFileSize()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The byte size of the document.</p>
        Returns:
        possible object is Long

      • setFileSize

        public void setFileSize​(Long value)
        Sets the value of the fileSize property.
        Parameters:
        value - allowed object is Long
        See Also:
        getFileSize()

      • getInitialPage

        public int getInitialPage()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The first page, that shall be displayed when opening the document in a PDF Reader.</p>
        Returns:
        possible object is Integer

      • setInitialPage

        public void setInitialPage​(Integer value)
        Sets the value of the initialPage property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getInitialPage()

      • getLanguage

        public String getLanguage()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The natural language of the document. This could either contain the language name or a language tag.</p>
        Returns:
        possible object is String

      • setLanguage

        public void setLanguage​(String value)
        Sets the value of the language property.
        Parameters:
        value - allowed object is String
        See Also:
        getLanguage()

      • getPageLayout

        public PageLayoutType getPageLayout()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The set initial page layout of the document. When opening the document in a Reader, this layout shall be selected to display pages.
                         <ul><li>singlePage = One page at a time.</li><li>oneColumn = One continuous column of pages.</li><li>twoColumnLeft = The pages in two columns, with odd
                                 <li>numbered pages on the left.</li></li><li>twoColumnRight = The pages in two columns, with odd
                                 <li>numbered pages on the right.</li></li><li>twoPageLeft = Display the pages two at a time, with odd
                                 <li>numbered pages on the left.</li></li><li>twoPageRight = Display the pages two at a time, with odd
                                 <li>numbered pages on the right.</li></li></ul></p>
        Returns:
        possible object is PageLayoutType

      • getMagnification

        public MagnificationType getMagnification()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The initial page zoom settings of the document. When opening the document in a Reader, this zoom settings shall be used.
                         <ul><li>none = Uses the application's default view.</li><li>fitWidth = Page width.</li><li>fitPage = Page dimensions.</li><li>fitHeight = Page height.</li><li>fitVisible = Page content width.</li><li>fitActual = Uses the original page dimensions (100% zoom factor).</li><li>zoom = Sets an explicit magnification value.</li></ul></p>
        Returns:
        possible object is MagnificationType

      • getMagnificationZoom

        public int getMagnificationZoom()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If a magnification "zoom" is selected for this document, this is the actual percentage the pages of the document shall be zoomed to, when opening the document in a PDF Reader.</p>
        Returns:
        possible object is Integer

      • setMagnificationZoom

        public void setMagnificationZoom​(Integer value)
        Sets the value of the magnificationZoom property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getMagnificationZoom()

      • getInitialView

        public InitialViewType getInitialView()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines which sub
                         <li>windows will be opened when the PDF document is opened.</li><ul><li>none = No special view</li><li>outlines = Opens the "Bookmarks" tab</li><li>thumbnails = Opens the "Thumbnails" tab</li><li>fullscreen = Opens the document in full screen mode</li></ul></p>
        Returns:
        possible object is InitialViewType

      • isEncrypted

        public boolean isEncrypted()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">This will be set to "true" for a document, that is either password protected or certificate encrypted.</p>
        Returns:
        possible object is Boolean

      • setEncrypted

        public void setEncrypted​(Boolean value)
        Sets the value of the encrypted property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isEncrypted()

      • isPortfolio

        public boolean isPortfolio()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Will be set to "true" for a "PDF collection" (Portfolio), that serves as the container for other documents.</p>
        Returns:
        possible object is Boolean

      • setPortfolio

        public void setPortfolio​(Boolean value)
        Sets the value of the portfolio property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isPortfolio()

      • getPages

        public int getPages()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of pages contained in the document.</p>
        Returns:
        possible object is Integer

      • setPages

        public void setPages​(Integer value)
        Sets the value of the pages property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getPages()

      • getAttachments

        public int getAttachments()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of attachments contained in the document.</p>
        Returns:
        possible object is Integer

      • setAttachments

        public void setAttachments​(Integer value)
        Sets the value of the attachments property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getAttachments()

      • getFormType

        public FormsFormatType getFormType()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to another value than "none", the document does contain a PDF form in the hereby given format.
                         <ul><li>none = The document does not contain a form.</li><li>acroForm = The document contains a standard PDF Acroform.</li><li>staticXFA = The document contains a "XML Forms Architecture" form with a fixed layout (static).</li><li>dynamicXFA = The document contains a "XML Forms Architecture" form with an adaptable/interactive layout (dynamic).</li></ul></p>
        Returns:
        possible object is FormsFormatType

      • getSignatures

        public int getSignatures()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of signatures contained in the document.</p>
        Returns:
        possible object is Integer

      • setSignatures

        public void setSignatures​(Integer value)
        Sets the value of the signatures property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getSignatures()

      • getDocMDP

        public DocMdpType getDocMDP()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">A document "Modification Detection and Prevention" may be set, that defines which modifications of the document are allowed and which modifications would render the signature invalid.
                         <ul><li>none = The document is unprotected</li><li>modify it as you please.</li><li>noChangesAllowed = Any modifications of the document would render the signatures invalid.</li><li>formFillingSignatures = You may fill in forms and further sign the document.</li><li>formFillingSignaturesAndAnnotations = Form filling, signing and adding annotations are allowed.</li></ul></p>
        Returns:
        possible object is DocMdpType

      • setDocMDP

        public void setDocMDP​(DocMdpType value)
        Sets the value of the docMDP property.
        Parameters:
        value - allowed object is DocMdpType
        See Also:
        getDocMDP()