Home » xmlbeans-2.4.0-src » org.apache.xmlbeans » [javadoc | source]

org.apache.xmlbeans
abstract public class: XmlDocumentProperties [javadoc | source]

java.lang.Object
   org.apache.xmlbeans.XmlDocumentProperties

Direct Known Subclasses:
    DocProps

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
public static final  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.
public static final  Object	ENCODING	Document encoding
public static final  Object	VERSION	Document version
public static final  Object	STANDALONE	Document standlone
public static final  Object	DOCTYPE_NAME	Doc type name
public static final  Object	DOCTYPE_PUBLIC_ID	Doc type public id
public static final  Object	DOCTYPE_SYSTEM_ID	Doc type system id
public static final  Object	MESSAGE_DIGEST	SHA message digest

Method from org.apache.xmlbeans.XmlDocumentProperties Summary:
get,   getDoctypeName,   getDoctypePublicId,   getDoctypeSystemId,   getEncoding,   getMessageDigest,   getSourceName,   getStandalone,   getVersion,   put,   remove,   setDoctypeName,   setDoctypePublicId,   setDoctypeSystemId,   setEncoding,   setMessageDigest,   setSourceName,   setStandalone,   setVersion

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.apache.xmlbeans.XmlDocumentProperties Detail:
abstract public Object get(Object key) Returns a value previously attached to a document using set.
public String getDoctypeName() { return (String) get( DOCTYPE_NAME ); } Returns the DOCTYPE name used in the <!DOCTYPE> declaration.
public String getDoctypePublicId() { return (String) get( DOCTYPE_PUBLIC_ID ); } Returns the DOCTYPE public ID used in the <!DOCTYPE> declaration.
public String getDoctypeSystemId() { return (String) get( DOCTYPE_SYSTEM_ID ); } Returns the DOCTYPE system ID used in the <!DOCTYPE> declaration.
public String getEncoding() { return (String) get( ENCODING ); } Returns the encoding used for the XML document, as an ISO encoding name.
public byte[] getMessageDigest() { return (byte[]) get( MESSAGE_DIGEST ); } Returns the message digest used to summarize the document.
public String getSourceName() { return (String) get( SOURCE_NAME ); } Returns the name of the XML document file. Typically a URL, but may be any String.
public boolean getStandalone() { return get( STANDALONE ) != null; } Returns the standalone property
public String getVersion() { return (String) get( VERSION ); } Returns the XML version string used in the <?xml?> declaration.
abstract public Object put(Object key, Object value) Attaches a value to the root of the document containing the given token source.
abstract public Object remove(Object key) Removes a value previously attached to a document using set.
public void setDoctypeName(String doctypename) { put( DOCTYPE_NAME, doctypename ); } Sets the DOCTYPE name use in the <!DOCTYPE> declaration.
public void setDoctypePublicId(String publicid) { put( DOCTYPE_PUBLIC_ID, publicid ); } Sets the DOCTYPE public ID to use in the <!DOCTYPE> declaration.
public void setDoctypeSystemId(String systemid) { put( DOCTYPE_SYSTEM_ID, systemid ); } Sets the DOCTYPE system ID to use in the <!DOCTYPE> declaration.
public void setEncoding(String encoding) { put( ENCODING, encoding ); } Sets the encoding to use for the XML document. Should be a valid XML encoding string.
public void setMessageDigest(byte[] digest) { put( MESSAGE_DIGEST, digest ); } Sets the message digest used to summarize the document.
public void setSourceName(String sourceName) { put( SOURCE_NAME, sourceName ); } Sets the name of the XML document file. Typically a URL, but may be any String.
public void setStandalone(boolean standalone) { put( STANDALONE, standalone ? "true" : null ); } Sets the standalone property.
public void setVersion(String version) { put( VERSION, version ); } Sets the XML version string to use in the <?xml?> declaration. (The XML specification is quite stable at "1.0".)