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

Class DocumentImpl

java.lang.Object
com.priint.pubserver.metadata.xml.base.DocumentImpl
All Implemented Interfaces:
Document, Serializable
Direct Known Subclasses:
ElementDocument, GroupDocument, ItemDocument, ManifestDocument, NoteDocument, PlaceholderDocument, SpreadDocument, W2MLDocument
public class DocumentImpl extends Object implements Serializable, Document
See Also:

  • Constructor Details

    • DocumentImpl

      public DocumentImpl()

  • Method Details

    • getVersion

      public 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(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 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(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 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(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 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(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 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(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 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(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 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(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 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(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 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(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 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(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 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(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 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(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 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(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 String getCreator()
      Description copied from interface: Document

      Gets the document creator.

      Specified by:
      getCreator in interface Document
      Returns:
      the creator

    • setCreator

      public void setCreator(String creator)
      Description copied from interface: Document

      Sets the document creator.

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