com.novell.nds.dirxml.driver.xds
Class XDSSchemaResultDocument

java.lang.Object
  com.novell.nds.dirxml.driver.xds.DocumentImpl
      com.novell.nds.dirxml.driver.xds.XDSSchemaResultDocument

All Implemented Interfaces:

StatusDocument, WriteableDocument, XDSDocument

public class XDSSchemaResultDocument

extends DocumentImpl

implements WriteableDocument, StatusDocument

The XmlDocument returned from the getSchema(XmlDocument) method of interface DriverShim.

Constructor Summary

XDSSchemaResultDocument()
Constructs an empty, writeable schema document.

XDSSchemaResultDocument(DTDVersion dtdVersion)
Constructs an empty, writeable schema document.

Method Summary

XDSSchemaDefElement	appendSchemaDefElement() Appends an empty, child <schema-def> element to this document's <output> element.
XDSSourceElement	appendSourceElement() Appends an empty, child <source> element to this document's <nds> element.
XDSStatusElement	appendStatusElement() Appends an empty, child <status> element to this document's <input> or <output> element.
void	empty() Removes all child nodes from this document's <input> or <output> element.
com.novell.nds.dirxml.driver.XmlDocument	toXML() Converts this document into an XmlDocument.
void	validate() Validates this document.

Methods inherited from class com.novell.nds.dirxml.driver.xds.DocumentImpl

domDocument, domIOElement, domNDSElement, isEmpty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.novell.nds.dirxml.driver.xds.XDSDocument

domDocument, domIOElement, domNDSElement, isEmpty

Constructor Detail

XDSSchemaResultDocument

public XDSSchemaResultDocument()

Constructs an empty, writeable schema document. By default, the current DTD version is used.

This constructor should be used to build documents returned from the getSchema(XmlDocument) method of interface DriverShim.

See Also:

SkeletonDriverShim.getSchema(XmlDocument)

XDSSchemaResultDocument

public XDSSchemaResultDocument(DTDVersion dtdVersion)

Constructs an empty, writeable schema document. The DTD version used is configurable.

This constructor should be used to build documents returned from the getSchema(XmlDocument) method of interface DriverShim.

Parameters:

dtdVersion - must not be null

See Also:

SkeletonDriverShim.getSchema(XmlDocument)

Method Detail

appendSchemaDefElement

public XDSSchemaDefElement appendSchemaDefElement()

Appends an empty, child <schema-def> element to this document's <output> element.

Invocation Context:

WRITE

Returns:

will not return null

appendSourceElement

public XDSSourceElement appendSourceElement()

Description copied from interface: WriteableDocument

Appends an empty, child <source> element to this document's <nds> element. When called more than once, no action is taken and the same <source> element is returned.

Invocation Context:

WRITE

Specified by:

appendSourceElement in interface WriteableDocument

Returns:

will not return null

appendStatusElement

public XDSStatusElement appendStatusElement()

Description copied from interface: StatusDocument

Appends an empty, child <status> element to this document's <input> or <output> element.

Invocation Context:

WRITE

Specified by:

appendStatusElement in interface StatusDocument

Returns:

will not return null

validate

public void validate()
              throws XDSParseException

Description copied from interface: WriteableDocument

Validates this document.

Invocation Context:

WRITE

Specified by:

validate in interface WriteableDocument

Throws:

XDSParseException - if this document is malformed or invalid

toXML

public com.novell.nds.dirxml.driver.XmlDocument toXML()

Description copied from interface: WriteableDocument

Converts this document into an XmlDocument.

Invocation Context:

WRITE

Specified by:

toXML in interface WriteableDocument

Returns:

this document as a XmlDocument

empty

public void empty()

Description copied from interface: WriteableDocument

Removes all child nodes from this document's <input> or <output> element.

Invocation Context:

WRITE

Specified by:

empty in interface WriteableDocument