Package org.openpreservation.odf.pkg

Interface Manifest

public interface Manifest

  • Method Details

    • getVersion

      String getVersion()
      Get the declared version of the Manifest from the root element.
      Returns:

    • hasRootMediaType

      boolean hasRootMediaType()
      Find out whether the manifest has a FileEntry with the full path attribute "/".
      Returns:
      true if a root element .

    • getRootMediaType

      String getRootMediaType()
      Get the declared media type of the Manifest from the root "/" element.
      Returns:
      the declared media type of the Manifest.

    • getRootVersion

      String getRootVersion()
      Get the declared version of the ODF package from the root "/" element.
      Returns:
      the declared version of the ODF package.

    • getEntryCount

      int getEntryCount()
      Get the number of entries in the Manifest.
      Returns:
      the numbner of manifest entries.

    • getEntries

      Set<FileEntry> getEntries()
      Get the Set of FileEntry objects in the Manifest.
      Returns:
      the set of file entries.

    • getEntriesByMediaType

      Set<FileEntry> getEntriesByMediaType(String mediaType)
      Get the Set of FileEntry objects in the Manifest that have the supplied media type.
      Parameters:
      mediaType - the media type to filter the entries by.
      Returns:
      the Set of FileEntry objects that have the supplied media type.

    • getEncryptedEntries

      Set<FileEntry> getEncryptedEntries()
      Get the Set of FileEntry objects fior all manifest entries with encryption XML data.
      Returns:
      the Set of FileEntry objects that have encryption XML data.

    • getEntry

      FileEntry getEntry(String entryName)
      Get a manifest entry by name
      Parameters:
      entryName - the name to find the entry by.
      Returns:
      the FileEntry object for the supplied name, or null if not found.

    • getEntryMediaType

      String getEntryMediaType(String entryName)
      Get a manifest entry media type by name
      Parameters:
      entryName - the name to find the entry by.
      Returns:
      the FileEntry media type for the supplied name, or null if not found.

    • getDocumentEntries

      Set<FileEntry> getDocumentEntries()
      Get the set of FileEntry objects that are documents, i.e. have a media type that is an ODF document.
      Returns: