org.ten60.netkernel.xml.xda
Interface IXDAReadOnly

All Known Subinterfaces:

IXDA, IXDAIterator, IXDAReadOnlyIterator

All Known Implementing Classes:

DOMXDA

public interface IXDAReadOnly

Method Summary

IXPathResult	eval(java.lang.String aTargetXPath) Evaluate the xpath against the document returning an IXPathResult
java.lang.String	getText(java.lang.String aTargetXPath, boolean aTrim) Return the text that is contained at the element located using an XPath
boolean	isTrue(java.lang.String aTargetXPath) Evaluate and xpath against the document returning a boolean result
IXDAReadOnlyIterator	readOnlyIterator(java.lang.String aTargetXPath) Return an iterator over all elements that match the an XPath
void	serialize(java.io.Writer aWriter, boolean indent) Serialize the whole document
void	serialize(java.io.Writer aWriter, java.lang.String aTargetXPath, boolean indent) Serialize part of the document

Method Detail

eval

IXPathResult eval(java.lang.String aTargetXPath)
                  throws XPathLocationException

Evaluate the xpath against the document returning an IXPathResult

Throws:

XPathLocationException - throw if the xpath is malformed

isTrue

boolean isTrue(java.lang.String aTargetXPath)
               throws XPathLocationException

Evaluate and xpath against the document returning a boolean result

Throws:

XPathLocationException - throw if the xpath is malformed

getText

java.lang.String getText(java.lang.String aTargetXPath,
                         boolean aTrim)
                         throws XPathLocationException

Return the text that is contained at the element located using an XPath

Parameters:

aTargetXPath - the xpath

aTrim - if true trim whitespace from the String

Returns:

the string

Throws:

XPathLocationException - throw if the xpath is malformed or doesn't point to a single unique element

readOnlyIterator

IXDAReadOnlyIterator readOnlyIterator(java.lang.String aTargetXPath)
                                      throws XPathLocationException

Return an iterator over all elements that match the an XPath

Parameters:

aTargetXPath - the xpath

Returns:

the iterator

Throws:

XPathLocationException - throw if the xpath is malformed

serialize

void serialize(java.io.Writer aWriter,
               java.lang.String aTargetXPath,
               boolean indent)
               throws XPathLocationException,
                      java.io.IOException

Serialize part of the document

Parameters:

aWriter - the writer to write the serialized document to

aTargetXPath - the xpath

indent - true if the document should be re-indented

Throws:

XPathLocationException - throw if the xpath is malformed or doesn't point to a single unique element

java.io.IOException - throw if the writer cannot be written to

serialize

void serialize(java.io.Writer aWriter,
               boolean indent)
               throws java.io.IOException

Serialize the whole document

Parameters:

aWriter - the writer to write the serialized document to

indent - true if the document should be re-indented

Throws:

java.io.IOException - throw if the writer cannot be written to