Package com.priint.pubserver.metadata.xml.base

Class DocumentImpl

    • Constructor Summary

      Constructors 
      Constructor Description
      DocumentImpl()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCreator()
      Gets the document creator.
      java.lang.String getDocumentId()
      Gets the document Id of this document.
      java.lang.String getDocumentName()
      Gets the document name.
      java.lang.String getDocumentPath()
      Gets the document path / parent folder.
      java.lang.Integer getElementId()
      Gets the element Id of the content described in this XML document.
      java.lang.Integer getGroupId()
      Gets the group Id of the content described in this XML document.
      java.lang.Boolean getIsConverted()
      Gets, whether this document has been converted, when being opened.
      java.lang.Boolean getIsMissingPlugIns()
      Gets, whether Plug-Ins where missing when generating this XML document.
      java.lang.Boolean getIsModified()
      Gets the modified state of the document, this XML document is based on.
      java.lang.Boolean getIsReadOnly()
      Gets, whether the document, this XML document is based on, is read only.
      java.lang.Integer getPageId()
      Gets the page Id of the content described in this XML document.
      java.lang.Integer getPluginRevision()
      Gets the revision of the application, which created this document.
      Scope getRef()
      Gets the scope of the document, which is covered by this XML document.
      java.lang.Integer getSpreadId()
      Gets the spread Id of the content described in this XML document.
      java.lang.String getVersion()
      Gets the version of the application, which created this document.
      void setCreator​(java.lang.String creator)
      Sets the document creator.
      void setDocumentId​(java.lang.String documentId)
      Sets the document Id of this document.
      void setDocumentName​(java.lang.String documentName)
      Sets the document name.
      void setDocumentPath​(java.lang.String documentPath)
      Sets the document path / parent folder.
      void setElementId​(java.lang.Integer elementId)
      Sets the element Id of the content described in this XML document.
      void setGroupId​(java.lang.Integer groupId)
      Sets the group Id of the content described in this XML document.
      void setIsConverted​(java.lang.Boolean isConverted)
      Sets, whether this document has been converted, when being opened.
      void setIsMissingPlugIns​(java.lang.Boolean isMissingPlugIns)
      Sets, whether Plug-Ins where missing when generating this XML document.
      void setIsModified​(java.lang.Boolean isModified)
      Sets the modified state of the document, this XML document is based on.
      void setIsReadOnly​(java.lang.Boolean isReadOnly)
      Sets, whether the document, this XML document is based on, is read only.
      void setPageId​(java.lang.Integer pageId)
      Sets the page Id of the content described in this XML document.
      void setPluginRevision​(java.lang.Integer pluginRevision)
      Sets the revision of the application, which created this document.
      void setRef​(Scope ref)
      Sets the scope of the document, which is covered by this XML document.
      void setSpreadId​(java.lang.Integer spreadId)
      Sets the spread Id of the content described in this XML document.
      void setVersion​(java.lang.String version)
      Sets the version of the application, which created this document.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DocumentImpl

        public DocumentImpl()

    • Method Detail

      • getVersion

        public java.lang.String getVersion()
        Description copied from interface: Document

        Gets the version of the application, which created this document.

        Gets the version of the application, which created this document.
        In case of priint:pdf renderer, this is the pdf renderer version, in case of InDesign, this is the version of the priint:comet Plug-Ins (rather than the InDesign version).

        Specified by:
        getVersion in interface Document
        Returns:
        the renderer version, which created this document

      • setVersion

        public void setVersion​(java.lang.String version)
        Description copied from interface: Document

        Sets the version of the application, which created this document.

        Sets the version of the application, which created this document.
        See also Document.getVersion().

        Specified by:
        setVersion in interface Document
        Parameters:
        version - renderer version, which created this document

      • getPluginRevision

        public java.lang.Integer getPluginRevision()
        Description copied from interface: Document

        Gets the revision of the application, which created this document.

        Gets the revision of the application, which created this document.
        See also Document.getVersion().

        Specified by:
        getPluginRevision in interface Document
        Returns:
        the revision of the renderer, which created this document

      • setPluginRevision

        public void setPluginRevision​(java.lang.Integer pluginRevision)
        Description copied from interface: Document

        Sets the revision of the application, which created this document.

        Sets the revision of the application, which created this document.
        See also Document.getVersion().

        Specified by:
        setPluginRevision in interface Document
        Parameters:
        pluginRevision - the revision of the renderer, which created this document

      • getRef

        public Scope getRef()
        Description copied from interface: Document

        Gets the scope of the document, which is covered by this XML document.

        Gets the scope of the document, which is covered by this XML document.
        Scope describes the region of the document, which is covered by a XML document. This could be the entire document (Scope.DOCUMENT) or a single frame (Scope.ELEMENT) or any other of the values defined by this enumeration.

        Specified by:
        getRef in interface Document
        Returns:
        scope of the document, which is covered by this XML document

      • setRef

        public void setRef​(Scope ref)
        Description copied from interface: Document

        Sets the scope of the document, which is covered by this XML document.

        Sets the scope of the document, which is covered by this XML document.
        See also Document.getRef()

        Specified by:
        setRef in interface Document
        Parameters:
        ref - scope of the document, which is covered by this XML document

      • getDocumentId

        public java.lang.String getDocumentId()
        Description copied from interface: Document

        Gets the document Id of this document.

        Gets the document Id of this document.
        There is no formal requirement for the Id of a document, however it should be possible to identify this document using this Id e.g. in a publication or document management system.

        Specified by:
        getDocumentId in interface Document
        Returns:
        Id of this document

      • setDocumentId

        public void setDocumentId​(java.lang.String documentId)
        Description copied from interface: Document

        Sets the document Id of this document.

        Sets the document Id of this document.
        There is no formal requirement for the Id of a document, however it should be possible to identify this document using this Id e.g. in a publication or document management system.

        Specified by:
        setDocumentId in interface Document
        Parameters:
        documentId - Id of this document

      • getSpreadId

        public java.lang.Integer getSpreadId()
        Description copied from interface: Document

        Gets the spread Id of the content described in this XML document.

        Gets the spread Id of the content described in this XML document.
        If the scope (see Document.getRef() of this XML document is a document spread, the spread Id is the index (zero based) of the spread contained in this XML document.

        Specified by:
        getSpreadId in interface Document
        Returns:
        Id (index) of the spread contained in this document

      • setSpreadId

        public void setSpreadId​(java.lang.Integer spreadId)
        Description copied from interface: Document

        Sets the spread Id of the content described in this XML document.

        Sets the spread Id of the content described in this XML document.
        If the scope (see Document.getRef() of this XML document is a document spread, the spread Id is the index (zero based) of the spread contained in this XML document.

        Specified by:
        setSpreadId in interface Document
        Parameters:
        spreadId - Id (index) of the spread contained in this document

      • getPageId

        public java.lang.Integer getPageId()
        Description copied from interface: Document

        Gets the page Id of the content described in this XML document.

        Gets the page Id of the content described in this XML document.
        If the scope (see Document.getRef() of this XML document is a document page, the page Id is the index (zero based) of the page contained in this XML document.

        Specified by:
        getPageId in interface Document
        Returns:
        Id (index) of the page contained in this document

      • setPageId

        public void setPageId​(java.lang.Integer pageId)
        Description copied from interface: Document

        Sets the page Id of the content described in this XML document.

        Sets the page Id of the content described in this XML document.
        If the scope (see Document.getRef() of this XML document is a document page, the page Id is the index (zero based) of the page contained in this XML document.

        Specified by:
        setPageId in interface Document
        Parameters:
        pageId - Id (index) of the page contained in this document

      • getGroupId

        public java.lang.Integer getGroupId()
        Description copied from interface: Document

        Gets the group Id of the content described in this XML document.

        Gets the group Id of the content described in this XML document.
        If the scope (see Document.getRef() of this XML document is a comet group, the group Id is the persistent UID of the comet group contained in this XML document.

        Specified by:
        getGroupId in interface Document
        Returns:
        persistent UID of the comet group contained in this document

      • setGroupId

        public void setGroupId​(java.lang.Integer groupId)
        Description copied from interface: Document

        Sets the group Id of the content described in this XML document.

        Sets the group Id of the content described in this XML document.
        If the scope (see Document.getRef() of this XML document is a comet group, the group Id is the persistent UID of the comet group contained in this XML document.

        Specified by:
        setGroupId in interface Document
        Parameters:
        groupId - persistent UID of the comet group contained in this document

      • getElementId

        public java.lang.Integer getElementId()
        Description copied from interface: Document

        Gets the element Id of the content described in this XML document.

        Gets the element Id of the content described in this XML document.
        If the scope (see Document.getRef() of this XML document is an element, the element Id is the persistent UID of the element contained in this XML document.

        Specified by:
        getElementId in interface Document
        Returns:
        persistent UID of the element contained in this document

      • setElementId

        public void setElementId​(java.lang.Integer elementId)
        Description copied from interface: Document

        Sets the element Id of the content described in this XML document.

        Sets the element Id of the content described in this XML document.
        If the scope (see Document.getRef() of this XML document is an element, the element Id is the persistent UID of the element contained in this XML document.

        Specified by:
        setElementId in interface Document
        Parameters:
        elementId - persistent UID of the element contained in this document

      • getDocumentPath

        public java.lang.String getDocumentPath()
        Description copied from interface: Document

        Gets the document path / parent folder.

        Gets the document path / parent folder of the document, this XML document is based on.
        Note: the path does not contain the filename.

        Specified by:
        getDocumentPath in interface Document
        Returns:
        document path / path of parent folder

      • setDocumentPath

        public void setDocumentPath​(java.lang.String documentPath)
        Description copied from interface: Document

        Sets the document path / parent folder.

        Sets the document path / parent folder of the document, this XML document is based on.
        Note: the path does not contain the filename.

        Specified by:
        setDocumentPath in interface Document
        Parameters:
        documentPath - document path / path of parent folder

      • getDocumentName

        public java.lang.String getDocumentName()
        Description copied from interface: Document

        Gets the document name.

        Gets the document name. This is the file system name of the document, this XML document is based on.

        Specified by:
        getDocumentName in interface Document
        Returns:
        name of the document, this XML document is based on.

      • setDocumentName

        public void setDocumentName​(java.lang.String documentName)
        Description copied from interface: Document

        Sets the document name.

        Sets the document name. This is the file system name of the document, this XML document is based on.

        Specified by:
        setDocumentName in interface Document
        Parameters:
        documentName - name of the document, this XML document is based on.

      • getIsMissingPlugIns

        public java.lang.Boolean getIsMissingPlugIns()
        Description copied from interface: Document

        Gets, whether Plug-Ins where missing when generating this XML document.

        Gets, whether Plug-Ins where missing when generating this XML document.
        If this flag is true, the content of this XML file is likely to be incomplete.

        Specified by:
        getIsMissingPlugIns in interface Document
        Returns:
        true, if Plug-Ins where missing, false otherwise.

      • setIsMissingPlugIns

        public void setIsMissingPlugIns​(java.lang.Boolean isMissingPlugIns)
        Description copied from interface: Document

        Sets, whether Plug-Ins where missing when generating this XML document.

        Sets, whether Plug-Ins where missing when generating this XML document.
        If this flag is true, the content of this XML file is likely to be incomplete.

        Specified by:
        setIsMissingPlugIns in interface Document
        Parameters:
        isMissingPlugIns - true, if Plug-Ins where missing, false otherwise.

      • getIsConverted

        public java.lang.Boolean getIsConverted()
        Description copied from interface: Document

        Gets, whether this document has been converted, when being opened.

        Gets, whether this document has been converted, when being opened.
        This flag is true, if a document has been opened e.g. with a newer InDesign version, than it was saved last.
        If this flag is true, certain properties (such as document path and name) may not be reliable.

        Specified by:
        getIsConverted in interface Document
        Returns:
        true, if the document has been converted, false otherwise.

      • setIsConverted

        public void setIsConverted​(java.lang.Boolean isConverted)
        Description copied from interface: Document

        Sets, whether this document has been converted, when being opened.

        Sets, whether this document has been converted, when being opened.
        This flag is true, if a document has been opened e.g. with a newer InDesign version, than it was saved last.
        If this flag is true, certain properties (such as document path and name) may not be reliable.

        Specified by:
        setIsConverted in interface Document
        Parameters:
        isConverted - true, if the document has been converted, false otherwise.

      • getIsModified

        public java.lang.Boolean getIsModified()
        Description copied from interface: Document

        Gets the modified state of the document, this XML document is based on.

        Gets the modified state of the document, this XML document is based on.
        If this flag is true, the content of this XML document does not reflect the saved state of the document.

        Specified by:
        getIsModified in interface Document
        Returns:
        true, if the document is in modified state, false otherwise.

      • setIsModified

        public void setIsModified​(java.lang.Boolean isModified)
        Description copied from interface: Document

        Sets the modified state of the document, this XML document is based on.

        Sets the modified state of the document, this XML document is based on.
        If this flag is true, the content of this XML document does not reflect the saved state of the document.

        Specified by:
        setIsModified in interface Document
        Parameters:
        isModified - true, if the document is in modified state, false otherwise.

      • getIsReadOnly

        public java.lang.Boolean getIsReadOnly()
        Description copied from interface: Document

        Gets, whether the document, this XML document is based on, is read only.

        Gets, whether the document, this XML document is based on, is read only.

        Specified by:
        getIsReadOnly in interface Document
        Returns:
        true, if the document is read only, false otherwise.

      • setIsReadOnly

        public void setIsReadOnly​(java.lang.Boolean isReadOnly)
        Description copied from interface: Document

        Sets, whether the document, this XML document is based on, is read only.

        Sets, whether the document, this XML document is based on, is read only.

        Specified by:
        setIsReadOnly in interface Document
        Parameters:
        isReadOnly - true, if the document is read only, false otherwise.

      • getCreator

        public java.lang.String getCreator()
        Description copied from interface: Document

        Gets the document creator.

        Specified by:
        getCreator in interface Document
        Returns:
        the creator

      • setCreator

        public void setCreator​(java.lang.String creator)
        Description copied from interface: Document

        Sets the document creator.

        Specified by:
        setCreator in interface Document
        Parameters:
        creator - the creator to set