Package org.openpreservation.odf.xml

Interface OdfXmlDocument

public interface OdfXmlDocument

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<Namespace>
    getForeignNamespaces()
    Get the set of foreign namespaces used in the document, e.g.
    String
    getLocalRootName()
    Get the name of the local/unqualified of the document's root element.
    String
    getMimeType()
    Get the declared ODF MIME type of the document, parsed from a root element attribute
    ParseResult
    getParseResult()
    Get the parse result of the XML document
    String
    getRootName()
    Get the namespace prefixed/qualfied name of the document's root element.
    Namespace
    getRootNamespace()
    Get the default namespace associated with the root element of the document
    String
    getVersion()
    Get the ODF version of the XML document, parsed from a root element attribute
    boolean
    hasMimeType()
    Does the document declare a MIME type?
    boolean
    hasVersion()
    Does the document declare a version?
    boolean
    isExtended()
    Establish whether the document uses a namespace outside of the declared ODF namespaces.

  • Method Details

    • getRootNamespace

      Namespace getRootNamespace()
      Get the default namespace associated with the root element of the document
      Returns:
      the root element namespace

    • getLocalRootName

      String getLocalRootName()
      Get the name of the local/unqualified of the document's root element.
      Returns:
      the unqualified name of the root element

    • getRootName

      String getRootName()
      Get the namespace prefixed/qualfied name of the document's root element.
      Returns:
      the unqualified name of the root element

    • hasMimeType

      boolean hasMimeType()
      Does the document declare a MIME type?
      Returns:
      true if the document declares a MIME type, otherwise false

    • getMimeType

      String getMimeType()
      Get the declared ODF MIME type of the document, parsed from a root element attribute
      Returns:
      the value of the mimetype attribute or null if no attribute found.

    • hasVersion

      boolean hasVersion()
      Does the document declare a version?
      Returns:
      true if the document declares a version, otherwise false

    • getVersion

      String getVersion()
      Get the ODF version of the XML document, parsed from a root element attribute
      Returns:
      The value of the version attribute or null if no attribute found

    • getForeignNamespaces

      Set<Namespace> getForeignNamespaces()
      Get the set of foreign namespaces used in the document, e.g. all of the namespaces outside of the declared ODF namespaces.
      Returns:

    • isExtended

      boolean isExtended()
      Establish whether the document uses a namespace outside of the declared ODF namespaces.
      Returns:
      true if the document uses a namespace outside of the declared ODF namespaces

    • getParseResult

      ParseResult getParseResult()
      Get the parse result of the XML document
      Returns:
      the parse result of the XML document