XmlDocument

java.lang.Object
- com.novell.nds.dirxml.driver.XmlDocument

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class XmlDocument
extends java.lang.Object
implements java.io.Externalizable
```
The XmlDocument class wraps an XML document and allows that document to be accessed via DOM, SAX (v1), or a serialized form.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`documentBytes`
`protected org.w3c.dom.Document`	`documentDOM`
`protected java.lang.String`	`documentString`
`static int`	`DOM` Value returned from `getSource()` indicating that the XML data was set using a DOM `Document`.
`protected boolean`	`indent`
`protected org.xml.sax.InputSource`	`inputSource`
`static int`	`NOT_SET` Value returned from `getSource()` indicating that the XML data has not been set in the `XmlDocument` instance.
`static int`	`SAX` Value returned from `getSource()` indicating that the XML data was set using a SAX `Parser` and `InputSource`.
`protected org.xml.sax.Parser`	`saxParser`
`static int`	`SERIALIZED` Value returned from `getSource()` indicating that the XML data was set using a `String` or a `byte` array.
`protected int`	`source`
`protected com.novell.xml.parser.XMLParser`	`xmlDocParser`

Constructor Summary

Constructors
Constructor and Description
`XmlDocument()` Construct an empty XML document
`XmlDocument(byte[] document)` Construct an XML document based on an XML byte array
`XmlDocument(org.w3c.dom.Document document)` Construct an XML document based on a DOM document
`XmlDocument(org.xml.sax.Parser parser, org.xml.sax.InputSource inputSource)` Construct an XML document based on a SAX Parser and InputSource
`XmlDocument(java.lang.String document)` Construct an XML document based on an XML string

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.w3c.dom.Document`	`getDocument()` get document contents as a DOM document
`byte[]`	`getDocumentBytes(java.lang.String encoding)` get document contents as a `byte` array
`com.novell.xml.dom.DocumentImpl`	`getDocumentEx()` Get a DOM document representation using Novell's implementation.
`org.xml.sax.InputSource`	`getDocumentInputSource()` Get SAX InputSource to use with SAX Parser returned from `getSAX()`.
`org.w3c.dom.Document`	`getDocumentNS()` get document contents as a DOM Level 2 document with namespace information.
`org.xml.sax.Parser`	`getDocumentSAX()` get document contents as via a SAX Parser
`java.lang.String`	`getDocumentString()` get document contents as a `String`
`boolean`	`getIndent()` Get if whitespace may be added for formatting when serializing document
`com.novell.xml.parser.XMLParser`	`getParser()` get the parser used by this document
`java.util.Vector`	`getParserErrorMsgs()` get any pending parser error messages
`java.lang.String`	`getParserErrorMsgString()` get any pending parser error messages, concatenated into one string and separated by a newline
`int`	`getSource()` Return the original source of the XML contained in this instance.
`com.novell.xml.util.XmlWriter`	`getXmlWriter(java.io.OutputStream outputStream, java.lang.String encoding)` Return an XmlWriter instance suitable for serializing the document
`com.novell.xml.util.XmlWriter`	`getXmlWriter(java.io.Writer writer)` Return an XmlWriter instance suitable for serializing the document
`void`	`readDocument(java.io.InputStream document)` read document contents from an InputStream
`void`	`readDocument(java.io.InputStream document, java.lang.String documentURI)`
`void`	`readDocument(java.io.Reader document)` read document contents from a Reader
`void`	`readDocument(java.lang.String document)` read document contents from a URI string
`void`	`readDocument(java.net.URL document)` read document contents from a URL
`void`	`readExternal(java.io.ObjectInput in)` Mandatory readExternal method.
`void`	`setDocument(byte[] document)` set document contents based an XML byte array
`void`	`setDocument(org.w3c.dom.Document document)` set document contents based a DOM document
`void`	`setDocument(org.xml.sax.Parser parser, org.xml.sax.InputSource inputSource)`
`void`	`setDocument(java.lang.String document)` set document contents based an XML string
`void`	`setIndent(boolean indent)` Add whitespace for formatting to serialized document
`void`	`writeDocument(java.io.OutputStream document, java.lang.String encoding)` write document content to an OutputStream
`void`	`writeDocument(java.io.Writer document)` write document contents to Writer
`void`	`writeExternal(java.io.ObjectOutput out)` Mandatory writeExernal method for object Serialization.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NOT_SET
```
public static final int NOT_SET
```
    Value returned from getSource() indicating that the XML data has not been set in the XmlDocument instance.
    
    See Also:
    
    Constant Field Values
  - DOM
```
public static final int DOM
```
    Value returned from getSource() indicating that the XML data was set using a DOM Document.
    
    See Also:
    
    Constant Field Values
  - SAX
```
public static final int SAX
```
    Value returned from getSource() indicating that the XML data was set using a SAX Parser and InputSource.
    
    See Also:
    
    Constant Field Values
  - SERIALIZED
```
public static final int SERIALIZED
```
    Value returned from getSource() indicating that the XML data was set using a String or a byte array.
    
    See Also:
    
    Constant Field Values
  - documentDOM
```
protected org.w3c.dom.Document documentDOM
```
  - documentString
```
protected java.lang.String documentString
```
  - documentBytes
```
protected byte[] documentBytes
```
  - indent
```
protected boolean indent
```
  - saxParser
```
protected org.xml.sax.Parser saxParser
```
  - inputSource
```
protected org.xml.sax.InputSource inputSource
```
  - source
```
protected int source
```
  - xmlDocParser
```
protected com.novell.xml.parser.XMLParser xmlDocParser
```
- Constructor Detail
  - XmlDocument
```
public XmlDocument()
```
    Construct an empty XML document
  - XmlDocument
```
public XmlDocument(org.w3c.dom.Document document)
```
    Construct an XML document based on a DOM document
    
    Parameters:
    
    document - the document
  - XmlDocument
```
public XmlDocument(java.lang.String document)
```
    Construct an XML document based on an XML string
    
    Parameters:
    
    document - the document
  - XmlDocument
```
public XmlDocument(byte[] document)
```
    Construct an XML document based on an XML byte array
    
    Parameters:
    
    document - the document
  - XmlDocument
```
public XmlDocument(org.xml.sax.Parser parser,
                   org.xml.sax.InputSource inputSource)
```
    Construct an XML document based on a SAX Parser and InputSource
    
    Parameters:
    
    parser - The SAX Parser interface
    
    inputSource - The SAX InputSource interface
- Method Detail
  - getSource
```
public int getSource()
```
    Return the original source of the XML contained in this instance.
    
    Returns:
    
    NOT_SET, DOM, SAX, or SERIALIZED.
  - setDocument
```
public void setDocument(org.w3c.dom.Document document)
```
    set document contents based a DOM document
    
    Parameters:
    
    document - the document
  - setDocument
```
public void setDocument(java.lang.String document)
```
    set document contents based an XML string
    
    Parameters:
    
    document - the document
  - setDocument
```
public void setDocument(byte[] document)
```
    set document contents based an XML byte array
    
    Parameters:
    
    document - the document
  - setDocument
```
public void setDocument(org.xml.sax.Parser parser,
                        org.xml.sax.InputSource inputSource)
```
  - readDocument
```
public void readDocument(java.io.InputStream document)
```
    read document contents from an InputStream
    
    Parameters:
    
    document - the document
  - readDocument
```
public void readDocument(java.io.InputStream document,
                         java.lang.String documentURI)
                  throws java.net.MalformedURLException
```
    Throws:
    
    java.net.MalformedURLException
  - readDocument
```
public void readDocument(java.io.Reader document)
```
    read document contents from a Reader
    
    Parameters:
    
    document - the document
  - readDocument
```
public void readDocument(java.net.URL document)
                  throws java.io.IOException
```
    read document contents from a URL
    
    Parameters:
    
    document - the document URL
    
    Throws:
    
    java.io.IOException
  - readDocument
```
public void readDocument(java.lang.String document)
                  throws java.io.IOException
```
    read document contents from a URI string
    
    Parameters:
    
    document - the document URI string
    
    Throws:
    
    java.io.IOException
  - writeDocument
```
public void writeDocument(java.io.OutputStream document,
                          java.lang.String encoding)
                   throws java.io.IOException,
                          java.io.UnsupportedEncodingException
```
    write document content to an OutputStream
    
    Parameters:
    
    document - the document
    
    encoding - desired encoding
    
    Throws:
    
    java.io.IOException
    
    java.io.UnsupportedEncodingException
  - writeDocument
```
public void writeDocument(java.io.Writer document)
                   throws java.io.IOException
```
    write document contents to Writer
    
    Parameters:
    
    document - the document
    
    Throws:
    
    java.io.IOException
  - getDocument
```
public org.w3c.dom.Document getDocument()
```
    get document contents as a DOM document
    
    Returns:
    
    the document node
  - getDocumentNS
```
public org.w3c.dom.Document getDocumentNS()
```
    get document contents as a DOM Level 2 document with namespace information. Note: This may replace the original DOM document with a copy if needed
    
    Returns:
    
    the document node
  - getDocumentEx
```
public com.novell.xml.dom.DocumentImpl getDocumentEx()
```
    Get a DOM document representation using Novell's implementation.
    
    Returns:
    
    the document node.
  - getDocumentString
```
public java.lang.String getDocumentString()
```
    get document contents as a String
    
    Returns:
    
    the serialized document
  - getDocumentBytes
```
public byte[] getDocumentBytes(java.lang.String encoding)
```
    get document contents as a byte array
    
    Parameters:
    
    encoding - desired encoding
    
    Returns:
    
    the serialized document
  - getDocumentSAX
```
public org.xml.sax.Parser getDocumentSAX()
```
    get document contents as via a SAX Parser
    
    Returns:
    
    A SAX Parser interface through which to get the document contents
  - getDocumentInputSource
```
public org.xml.sax.InputSource getDocumentInputSource()
```
    Get SAX InputSource to use with SAX Parser returned from getSAX().
    
    Returns:
    
    The SAX InputSource to use with the returned SAX Parser from getSAX().
  - getXmlWriter
```
public com.novell.xml.util.XmlWriter getXmlWriter(java.io.OutputStream outputStream,
                                                  java.lang.String encoding)
                                           throws java.io.UnsupportedEncodingException
```
    Return an XmlWriter instance suitable for serializing the document
    
    Parameters:
    
    outputStream - The OutputStream to which to write.
    
    encoding - The character encoding to use in writing to the OutputStream
    
    Throws:
    
    java.io.UnsupportedEncodingException
  - getXmlWriter
```
public com.novell.xml.util.XmlWriter getXmlWriter(java.io.Writer writer)
```
    Return an XmlWriter instance suitable for serializing the document
    
    Parameters:
    
    writer - A Writer instance to which to serialize the document
  - getParser
```
public com.novell.xml.parser.XMLParser getParser()
```
    get the parser used by this document
    
    Returns:
    
    the parser
  - getParserErrorMsgs
```
public java.util.Vector getParserErrorMsgs()
```
    get any pending parser error messages
    
    Returns:
    
    the messages
  - getParserErrorMsgString
```
public java.lang.String getParserErrorMsgString()
```
    get any pending parser error messages, concatenated into one string and separated by a newline
    
    Returns:
    
    the messages
  - setIndent
```
public void setIndent(boolean indent)
```
    Add whitespace for formatting to serialized document
    
    Parameters:
    
    indent - True if whitespace may be added to serialized document
  - getIndent
```
public boolean getIndent()
```
    Get if whitespace may be added for formatting when serializing document
    
    Returns:
    
    True if whitespace may be added
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Mandatory writeExernal method for object Serialization.
    
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Mandatory readExternal method. Explicitly restores the supertype's fields and then restores this class's fields
    
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException

Class XmlDocument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOT_SET

DOM

SAX

SERIALIZED

documentDOM

documentString

documentBytes

indent

saxParser

inputSource

source

xmlDocParser

Constructor Detail

XmlDocument

XmlDocument

XmlDocument

XmlDocument

XmlDocument

Method Detail

getSource

setDocument

setDocument

setDocument

setDocument

readDocument

readDocument

readDocument

readDocument

readDocument

writeDocument

writeDocument

getDocument

getDocumentNS

getDocumentEx

getDocumentString

getDocumentBytes

getDocumentSAX

getDocumentInputSource

getXmlWriter

getXmlWriter

getParser

getParserErrorMsgs

getParserErrorMsgString

setIndent

getIndent

writeExternal

readExternal