org.umber.bellows.loader
Class DocumentInfo

java.lang.Object
  extended byorg.umber.bellows.loader.DocumentInfo

public final class DocumentInfo
extends java.lang.Object

Data holder for document-level XML data. Used by SAXLoader to store XML document properties, processing instructions outside the document, and NOTATION declarations.

Author:
jsheets

Constructor Summary
DocumentInfo()
          Creates a new instance of DocumentInfo.
 
Method Summary
 java.lang.String getEncoding()
          Retrieves the XML encoding used in the source XML document.
 Datum[] getNotations()
          Retrieves the NOTATION declarations for this document.
 Datum[] getPiAfterRoot()
          Retrieves all XML processing instructions that occur after the end of the root XML element.
 Datum[] getPiBeforeRoot()
          Retrieves all XML processing instructions that occur before the start of the root XML element.
 java.lang.String getXmlVersion()
          Retrieves the original document's XML version.
 boolean isStandalone()
          Retrieves the value of the XML standalone parameter.
 void setEncoding(java.lang.String encoding)
          Assigns the XML encoding used in the source XML document.
 void setNotations(Datum[] notations)
          Assigns the NOTATION declarations for this document.
 void setPiAfterRoot(Datum[] piAfterRoot)
          Assigns all XML processing instructions that occur after the end of the root XML element.
 void setPiBeforeRoot(Datum[] piBeforeRoot)
          Assigns all XML processing instructions that occur before the start of the root XML element.
 void setStandalone(boolean standalone)
          Assigns the value of the XML standalone parameter.
 void setXmlVersion(java.lang.String xmlVersion)
          Assigns the original document's XML version.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentInfo

public DocumentInfo()
Creates a new instance of DocumentInfo.

Method Detail

getEncoding

public java.lang.String getEncoding()
Retrieves the XML encoding used in the source XML document.

Returns:
the original document's XML encoding

setEncoding

public void setEncoding(java.lang.String encoding)
Assigns the XML encoding used in the source XML document.

Parameters:
encoding - the original document's XML encoding

isStandalone

public boolean isStandalone()
Retrieves the value of the XML standalone parameter.

Returns:
the original document's XML standalone

setStandalone

public void setStandalone(boolean standalone)
Assigns the value of the XML standalone parameter.

Parameters:
standalone - the original document's XML standalone

getXmlVersion

public java.lang.String getXmlVersion()
Retrieves the original document's XML version.

Returns:
the original document's XML version

setXmlVersion

public void setXmlVersion(java.lang.String xmlVersion)
Assigns the original document's XML version.

Parameters:
xmlVersion - the original document's XML version

getNotations

public Datum[] getNotations()
Retrieves the NOTATION declarations for this document.

Returns:
the NOTATION declarations

setNotations

public void setNotations(Datum[] notations)
Assigns the NOTATION declarations for this document.

Parameters:
notations - the NOTATION declarations

getPiBeforeRoot

public Datum[] getPiBeforeRoot()
Retrieves all XML processing instructions that occur before the start of the root XML element.

Returns:
all pre-root processing instructions

setPiBeforeRoot

public void setPiBeforeRoot(Datum[] piBeforeRoot)
Assigns all XML processing instructions that occur before the start of the root XML element.

Parameters:
piBeforeRoot - all pre-root processing instructions

getPiAfterRoot

public Datum[] getPiAfterRoot()
Retrieves all XML processing instructions that occur after the end of the root XML element.

Returns:
all post-root processing instructions

setPiAfterRoot

public void setPiAfterRoot(Datum[] piAfterRoot)
Assigns all XML processing instructions that occur after the end of the root XML element.

Parameters:
piAfterRoot - all post-root processing instructions