|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.nds.dirxml.driver.xds.DocumentImpl
com.novell.nds.dirxml.driver.xds.XDSQueryDocument
The XmlDocument
passed to the query(XmlDocument)
method of interface XmlQueryProcessor
.
Interface PublicationShim implements this method. An XmlQueryProcessor object reference is passed to the SubscriptionShim.execute(XmlDocument, XmlQueryProcessor) method.
Constructor Summary | |
XDSQueryDocument()
Constructs an empty, writeable query document. |
|
XDSQueryDocument(DTDVersion dtdVersion)
Constructs an empty, writeable query document. |
|
XDSQueryDocument(com.novell.nds.dirxml.driver.XmlDocument xdsXML)
Constructs a readable query document from an existing XDS-formatted, XML document. |
Method Summary | |
XDSQueryElement |
appendQueryElement()
Appends an empty, child <query> element to this
document's <input> element. |
XDSQueryExElement |
appendQueryExElement()
Appends an empty, child <query-ex> element to this
document's <input> element. |
XDSSourceElement |
appendSourceElement()
Appends an empty, child <source> element to this
document's <nds> element. |
List |
childElements()
Returns the child elements of this document's <input>
element. |
void |
empty()
Removes all child nodes from this document's <input>
or <output> element. |
List |
extractQueryElements()
Returns this element's child <query> and
<query-ex> elements. |
XDSSourceElement |
extractSourceElement()
Returns this document's <source> element. |
DTDVersion |
getDTDVersion()
Returns the dtdversion attribute value from this document's
<nds> 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 |
public XDSQueryDocument(com.novell.nds.dirxml.driver.XmlDocument xdsXML) throws XDSParseException
This constructor should be used to parse documents passed to method
query(XmlDocument)
of interface
PublicationShim
.
xdsXML
- must not be null
XDSParseException
- thrown if xdsXML
is empty,
malformed, or invalidSkeletonPublicationShim.query(XmlDocument)
public XDSQueryDocument()
This constructor should be used to build documents passed to the
XmlQueryProcessor
object passed to method
execute(XmlDocument, XmlQueryProcessor)
of interface
SubscriptionShim
.
SkeletonSubscriptionShim.execute(XmlDocument,
com.novell.nds.dirxml.driver.XmlQueryProcessor)
public XDSQueryDocument(DTDVersion dtdVersion)
This constructor should be used to build documents passed to the
XmlQueryProcessor
object passed to method
execute(XmlDocument, XmlQueryProcessor)
of interface
SubscriptionShim
.
dtdVersion
- must not be null
SkeletonSubscriptionShim.execute(XmlDocument,
com.novell.nds.dirxml.driver.XmlQueryProcessor)
Method Detail |
public XDSSourceElement extractSourceElement()
ReadableDocument
<source>
element.
extractSourceElement
in interface ReadableDocument
null
public List extractQueryElements()
<query>
and
<query-ex>
elements.
java.util.Collections.EMPTY_LIST
or a list of
XDSQueryElement
and XDSQueryExElement
objects; will not return null
public DTDVersion getDTDVersion()
ReadableDocument
dtdversion
attribute value from this document's
<nds>
element.
getDTDVersion
in interface ReadableDocument
null
; if absent, this method
returns DTDVersion.UNKNOWN
public List childElements()
<input>
element.
childElements
in interface ReadableDocument
Collections.EMPTY_LIST
or a list of
XDSQueryElement
, XDSQueryExElement
and NonXDSElement
objects; will not return
null
public XDSQueryElement appendQueryElement()
<query>
element to this
document's <input>
element.
null
public XDSQueryExElement appendQueryExElement()
<query-ex>
element to this
document's <input>
element.
null
public XDSSourceElement appendSourceElement()
WriteableDocument
<source>
element to this
document's <nds>
element. When called more than
once, no action is taken and the same <source>
element is returned.
appendSourceElement
in interface WriteableDocument
null
public void validate() throws XDSParseException
WriteableDocument
validate
in interface WriteableDocument
XDSParseException
- if this document is malformed or invalidpublic com.novell.nds.dirxml.driver.XmlDocument toXML()
WriteableDocument
XmlDocument
.
toXML
in interface WriteableDocument
XmlDocument
public void empty()
WriteableDocument
<input>
or <output>
element.
empty
in interface WriteableDocument
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |