Package org.openpreservation.odf.document

Interface OpenDocument

public interface OpenDocument

  • Method Summary

    Modifier and Type
    Method
    Description
    OdfDocument
    getDocument()
    Get the main ODF Document details, this will be the only document for a single XML file, a package may have sub-documents
    FileType
    getFileType()
    Indicates the type of OpenDocument, a zip archive package or a single XML file
    Formats
    getFormat()
    Get the format of the OpenDocument, this will be the declared format of the package or the parsed format of a single document.
    OdfPackage
    getPackage()
    Get the ODF Package for the OpenDocument, this will be null for a single XML file.
    Path
    getPath()
    Get the path to the OpenDocument file.
    Collection<OdfDocument>
    getSubDocuments()
    For and ODF Package get the sub-documents, these will be the documents in the package other than the main document.
    Version
    getVersion()
    Get the version of the OpenDocument.
    boolean
    isPackage()
    Is the OpenDocument an ODF package, i.e.

  • Method Details

    • getPath

      Path getPath()
      Get the path to the OpenDocument file.
      Returns:
      the path to the OpenDocument file

    • getFileType

      FileType getFileType()
      Indicates the type of OpenDocument, a zip archive package or a single XML file
      Returns:
      an enumerated FileType valued indicating the type of OpenDocument

    • isPackage

      boolean isPackage()
      Is the OpenDocument an ODF package, i.e. a zip archive
      Returns:
      true if the OpenDocument is a package

    • getDocument

      OdfDocument getDocument()
      Get the main ODF Document details, this will be the only document for a single XML file, a package may have sub-documents
      Returns:
      the main ODF Document for the OpenDocument file

    • getSubDocuments

      Collection<OdfDocument> getSubDocuments()
      For and ODF Package get the sub-documents, these will be the documents in the package other than the main document. Single file OpenDocuments return an empty collection.
      Returns:
      the Collection of OdfDocument sub-documents.

    • getPackage

      OdfPackage getPackage()
      Get the ODF Package for the OpenDocument, this will be null for a single XML file.
      Returns:
      the ODF Package for the OpenDocument

    • getFormat

      Formats getFormat()
      Get the format of the OpenDocument, this will be the declared format of the package or the parsed format of a single document.
      Returns:
      the format of the OpenDocument

    • getVersion

      Version getVersion()
      Get the version of the OpenDocument.
      Returns:
      the version of the OpenDocument