Package org.apache.xmlbeans

Class XmlDocumentProperties

  • public abstract class XmlDocumentProperties
extends java.lang.Object
    This class is used to attach arbitrary information to an XML document. It also defines several well-known types of information that can be attached or found on a document.

    For example, suppose you wanted to associate a filename with the document containing an xml object "xobj". This could be done via the following code:

    tokenSource.documentProperties().set(XmlDocumentProperties.NAME, "MyFilename.xml");

    To fetch the filename later, given an xobj2 anywhere in the same document, you can write:

    filename = (String)tokenSource.documentProperties().get(XmlDocumentProperties.NAME);

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.Object DOCTYPE_NAME
      Doc type name
      static java.lang.Object DOCTYPE_PUBLIC_ID
      Doc type public id
      static java.lang.Object DOCTYPE_SYSTEM_ID
      Doc type system id
      static java.lang.Object ENCODING
      Document encoding
      static java.lang.Object MESSAGE_DIGEST
      SHA message digest
      static java.lang.Object SOURCE_NAME
      Used to store the original name (a String) for the source from which the XML document was loaded.
      static java.lang.Object STANDALONE
      Document standlone
      static java.lang.Object VERSION
      Document version

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract java.lang.Object get​(java.lang.Object key)
      Returns a value previously attached to a document using set.
      java.lang.String getDoctypeName()
      Returns the DOCTYPE name used in the <!DOCTYPE> declaration.
      java.lang.String getDoctypePublicId()
      Returns the DOCTYPE public ID used in the <!DOCTYPE> declaration.
      java.lang.String getDoctypeSystemId()
      Returns the DOCTYPE system ID used in the <!DOCTYPE> declaration.
      java.lang.String getEncoding()
      Returns the encoding used for the XML document, as an ISO encoding name.
      byte[] getMessageDigest()
      Returns the message digest used to summarize the document.
      java.lang.String getSourceName()
      Returns the name of the XML document file.
      boolean getStandalone()
      Returns the standalone property
      java.lang.String getVersion()
      Returns the XML version string used in the <?xml?> declaration.
      abstract java.lang.Object put​(java.lang.Object key, java.lang.Object value)
      Attaches a value to the root of the document containing the given token source.
      abstract java.lang.Object remove​(java.lang.Object key)
      Removes a value previously attached to a document using set.
      void setDoctypeName​(java.lang.String doctypename)
      Sets the DOCTYPE name use in the <!DOCTYPE> declaration.
      void setDoctypePublicId​(java.lang.String publicid)
      Sets the DOCTYPE public ID to use in the <!DOCTYPE> declaration.
      void setDoctypeSystemId​(java.lang.String systemid)
      Sets the DOCTYPE system ID to use in the <!DOCTYPE> declaration.
      void setEncoding​(java.lang.String encoding)
      Sets the encoding to use for the XML document.
      void setMessageDigest​(byte[] digest)
      Sets the message digest used to summarize the document.
      void setSourceName​(java.lang.String sourceName)
      Sets the name of the XML document file.
      void setStandalone​(boolean standalone)
      Sets the standalone property.
      void setVersion​(java.lang.String version)
      Sets the XML version string to use in the <?xml?> declaration.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SOURCE_NAME

        public static final java.lang.Object SOURCE_NAME
        Used to store the original name (a String) for the source from which the XML document was loaded. This name, if present, is used to identify the document when reporting validation or comilation errors. XmlObject.Factory.parse(File) and SchemaTypeLoader.loadInstance(File) both automatically set this value to the filename.

      • ENCODING

        public static final java.lang.Object ENCODING
        Document encoding

      • VERSION

        public static final java.lang.Object VERSION
        Document version

      • STANDALONE

        public static final java.lang.Object STANDALONE
        Document standlone

      • DOCTYPE_NAME

        public static final java.lang.Object DOCTYPE_NAME
        Doc type name

      • DOCTYPE_PUBLIC_ID

        public static final java.lang.Object DOCTYPE_PUBLIC_ID
        Doc type public id

      • DOCTYPE_SYSTEM_ID

        public static final java.lang.Object DOCTYPE_SYSTEM_ID
        Doc type system id

      • MESSAGE_DIGEST

        public static final java.lang.Object MESSAGE_DIGEST
        SHA message digest

    • Constructor Detail

      • XmlDocumentProperties

        public XmlDocumentProperties()

    • Method Detail

      • setSourceName

        public void setSourceName​(java.lang.String sourceName)
        Sets the name of the XML document file. Typically a URL, but may be any String.
        Parameters:
        sourceName - the name to set
        See Also:
        XmlOptions.setDocumentSourceName(java.lang.String)

      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        Sets the encoding to use for the XML document. Should be a valid XML encoding string.
        Parameters:
        encoding - the ISO encoding name
        See Also:
        XmlOptions.setCharacterEncoding(java.lang.String)

      • setVersion

        public void setVersion​(java.lang.String version)
        Sets the XML version string to use in the <?xml?> declaration. (The XML specification is quite stable at "1.0".)
        Parameters:
        version - the XML version string

      • getVersion

        public java.lang.String getVersion()
        Returns the XML version string used in the <?xml?> declaration.

      • setStandalone

        public void setStandalone​(boolean standalone)
        Sets the standalone property.
        Parameters:
        standalone - whether standalone is true or not

      • getStandalone

        public boolean getStandalone()
        Returns the standalone property

      • setDoctypeName

        public void setDoctypeName​(java.lang.String doctypename)
        Sets the DOCTYPE name use in the <!DOCTYPE> declaration.
        Parameters:
        doctypename - the doctypename

      • getDoctypeName

        public java.lang.String getDoctypeName()
        Returns the DOCTYPE name used in the <!DOCTYPE> declaration.

      • setDoctypePublicId

        public void setDoctypePublicId​(java.lang.String publicid)
        Sets the DOCTYPE public ID to use in the <!DOCTYPE> declaration.
        Parameters:
        publicid - the public ID

      • getDoctypePublicId

        public java.lang.String getDoctypePublicId()
        Returns the DOCTYPE public ID used in the <!DOCTYPE> declaration.

      • setDoctypeSystemId

        public void setDoctypeSystemId​(java.lang.String systemid)
        Sets the DOCTYPE system ID to use in the <!DOCTYPE> declaration.
        Parameters:
        systemid - the system ID

      • getDoctypeSystemId

        public java.lang.String getDoctypeSystemId()
        Returns the DOCTYPE system ID used in the <!DOCTYPE> declaration.

      • setMessageDigest

        public void setMessageDigest​(byte[] digest)
        Sets the message digest used to summarize the document.
        Parameters:
        digest - the bytes of the digest
        See Also:
        XmlOptions.setLoadMessageDigest()

      • put

        public abstract java.lang.Object put​(java.lang.Object key,
                                     java.lang.Object value)
        Attaches a value to the root of the document containing the given token source.
        Parameters:
        key - The key: there can be one value for each key.
        value - The value to attach to the document.

      • get

        public abstract java.lang.Object get​(java.lang.Object key)
        Returns a value previously attached to a document using set.
        Parameters:
        key - The key: this is the key that was previously passed to set to store the value.
        Returns:
        The saved value, or null if none is found.

      • remove

        public abstract java.lang.Object remove​(java.lang.Object key)
        Removes a value previously attached to a document using set.
        Parameters:
        key - The key: this is the key that was previously passed to set to store the value.