org.exolab.adaptx.xslt.dom

Class XPNBuilder

Implemented Interfaces:
DocumentHandler, ResultHandler

public class XPNBuilder
extends java.lang.Object
implements ResultHandler

A ResultHandler implementation that builds a XPathNode tree
Version:
$Revision: 3916 $ $Date: 2003-09-29 15:32:17 -0400 (Mon, 29 Sep 2003) $
Author:
Keith Visco

Constructor Summary

XPNBuilder()
Creates a new XPNBuilder
XPNBuilder(String documentURI)
Creates a new XPNBuilder

Method Summary

void
cdata(char[] chars, int start, int length)
Signals to receive CDATA characters
void
characters(char[] chars, int start, int length)
Signals the start of characters
void
comment(String data)
Signals to recieve a comment
void
endDocument()
Signals the end of the document
void
endElement(String name)
Signals the start of element
void
endFragment()
void
entityReference(String name)
Signals to recieve an entity reference with the given name
XPathNode
getCurrentNode()
Returns the current node
XPathNode
getRoot()
Returns the Root node
void
ignorableWhitespace(char[] chars, int start, int length)
Signals the start of ignorable whitespace characters
boolean
isFinished()
Returns true if the DOM builder has completed
void
processingInstruction(String target, String data)
Signals to recieve a processing instruction
void
setDocumentLocator(Locator locator)
Sets the document locator
void
setEscapeText(boolean escapeText)
Sets the behavoir of handling character content.
void
setIndentSize(short indentSize)
Sets the indent size for all formatters that perform serialization, in which indentation is applicable.
void
setOutputFormat(OutputFormat format)
Sets the output format information for Formatters that perform serialization.
void
setSaveLocation(boolean saveLocation)
Sets whether or not to save location information.
void
startDocument()
Signals the start of a document
void
startElement(String name, AttributeList atts)
Signals the start of element
XPathNode
startFragment()
Starts a documentFragment and returns a handle to the fragment This fragment won't be added to the DOM tree
void
unescapedCharacters(char[] chars, int start, int length)
Signals to receive characters which should not be escaped

Constructor Details

XPNBuilder

public XPNBuilder()
Creates a new XPNBuilder

XPNBuilder

public XPNBuilder(String documentURI)
Creates a new XPNBuilder

Method Details

cdata

public void cdata(char[] chars,
                  int start,
                  int length)
Signals to receive CDATA characters
Specified by:
cdata in interface ResultHandler
Parameters:
chars - the character array containing the characters to receive
start - the index into the character array to start receiving characters at
length - the number of characters to recieve

characters

public void characters(char[] chars,
                       int start,
                       int length)
            throws org.xml.sax.SAXException
Signals the start of characters
Parameters:
chars - the character array containing the characters to receive
start - the index into the character array to start receiving characters at
length - the number of characters to recieve

comment

public void comment(String data)
Signals to recieve a comment
Specified by:
comment in interface ResultHandler
Parameters:

endDocument

public void endDocument()
            throws org.xml.sax.SAXException
Signals the end of the document

endElement

public void endElement(String name)
            throws org.xml.sax.SAXException
Signals the start of element
Parameters:
name - the name of the element

endFragment

public void endFragment()

entityReference

public void entityReference(String name)
Signals to recieve an entity reference with the given name
Specified by:
entityReference in interface ResultHandler
Parameters:
name - the name of the entity reference

getCurrentNode

public XPathNode getCurrentNode()
Returns the current node
Returns:
the current node

getRoot

public XPathNode getRoot()
Returns the Root node
Returns:
the root node

ignorableWhitespace

public void ignorableWhitespace(char[] chars,
                                int start,
                                int length)
            throws org.xml.sax.SAXException
Signals the start of ignorable whitespace characters
Parameters:
chars - the character array containing the characters to receive
start - the index into the character array to start receiving characters at
length - the number of characters to recieve

isFinished

public boolean isFinished()
Returns true if the DOM builder has completed
Returns:
true if the DOM builder has completed

processingInstruction

public void processingInstruction(String target,
                                  String data)
            throws org.xml.sax.SAXException
Signals to recieve a processing instruction
Parameters:
target - the target of the processing instruction
data - the content of the processing instruction

setDocumentLocator

public void setDocumentLocator(Locator locator)
Sets the document locator
Parameters:
locator - the Locator used by this DocumentHandler

setEscapeText

public void setEscapeText(boolean escapeText)
Sets the behavoir of handling character content. If argument is true, character content will be escaped. If false, character content will not be escaped.
Parameters:
escapeText - the flag indicating whether or not to escape character content

setIndentSize

public void setIndentSize(short indentSize)
Sets the indent size for all formatters that perform serialization, in which indentation is applicable.
Specified by:
setIndentSize in interface ResultHandler
Parameters:
indentSize - the number of characters to indent

setOutputFormat

public void setOutputFormat(OutputFormat format)
Sets the output format information for Formatters that perform serialization.
Specified by:
setOutputFormat in interface ResultHandler
Parameters:
format - the OutputFormat used to specify properties during serialization

setSaveLocation

public void setSaveLocation(boolean saveLocation)
Sets whether or not to save location information. Location information can only be saved if the Locator has been set by the SAX Parser.
Parameters:
saveLocation - a boolean that when true, indicates that location information should be saved if possible.

startDocument

public void startDocument()
            throws SAXException
Signals the start of a document

startElement

public void startElement(String name,
                         AttributeList atts)
            throws org.xml.sax.SAXException
Signals the start of element
Parameters:
name - the name of the element
atts - the AttributeList containing the associated attributes for the element

startFragment

public XPathNode startFragment()
Starts a documentFragment and returns a handle to the fragment This fragment won't be added to the DOM tree

unescapedCharacters

public void unescapedCharacters(char[] chars,
                                int start,
                                int length)
Signals to receive characters which should not be escaped
Specified by:
unescapedCharacters in interface ResultHandler
Parameters:
chars - the character array containing the characters to receive
start - the index into the character array to start receiving characters at
length - the number of characters to recieve