org.exolab.adaptx.xslt.util

Class ResultFormatter

public class ResultFormatter extends ErrorObserverAdapter

The ResultFormatter class used by the RuleProcessor to send results to. This class wraps a ResultHandler and does some common processing, such as namespace management.

Version: $Revision: 3633 $ $Date: 2003-03-01 02:38:44 -0500 (Sat, 01 Mar 2003) $

Author: Keith Visco

Constructor Summary
ResultFormatter(ResultHandler handler)
Creates a new ResultFormatter using the given ResultHandler
Method Summary
voidattribute(String name, String value, String nsURI)
Adds the given attribute to the result tree if attributes are allowed at the given time
booleanattsAllowed()
Returns true if an attribute can be successfully added to the current node.
voidcdata(String data)
Signals a block of CDATA content.
voidcdata(char[] chars, int start, int length)
Signals a block of CDATA content.
voidcharacters(String data)
Signals a block of character content.
voidcharacters(char[] chars, int start, int length)
Signals a block of character content.
voidcomment(String data)
Signals to recieve a comment.
voiddeclareNamespace(String prefix, String uri)
Declares the given namespace, the namespace will be added to the next element.
voidendElement(String name, String nsURI)
Signals the end of the current element.
voidentityReference(String name)
Signals to recieve an entity reference with the given name.
voidflush()
The processor state doesn't always send data to the Formatter, until necessary.
ResultHandlergetResultHandler()
Returns the ResultHandler being used by this ResultFormatter.
voidignorableWhitespace(char[] chars, int start, int length)
Signals the start of ignorable whitespace characters.
booleanisNamespaceDeclared(String namespace)
Returns true if the given namespace has been declared.
voidprocessingInstruction(String target, String data)
Signals to receive the processing instruction.
voidstartElement(String name, String nsURI)
Signals the start of an element.
voidunescapedCharacters(String data)
Signals to receive characters which should not be escaped.
voidunescapedCharacters(char[] chars, int start, int length)
Signals to receive characters which should not be escaped.

Constructor Detail

ResultFormatter

public ResultFormatter(ResultHandler handler)
Creates a new ResultFormatter using the given ResultHandler

Parameters: handler the ResultHandler to send data to

Method Detail

attribute

public void attribute(String name, String value, String nsURI)
Adds the given attribute to the result tree if attributes are allowed at the given time

Parameters: name the name of the attribute value the value of the attribute

attsAllowed

public boolean attsAllowed()
Returns true if an attribute can be successfully added to the current node.

Returns: true if an attribute can be successfully added to the current node.

cdata

public void cdata(String data)
Signals a block of CDATA content.

Parameters: data the CDATA section content

cdata

public void cdata(char[] chars, int start, int length)
Signals a block of CDATA content.

Parameters: chars a char[] containing the CDATA section content start the start offset into the char[] length the number of characters

characters

public void characters(String data)
Signals a block of character content.

Parameters: data the character content

characters

public void characters(char[] chars, int start, int length)
Signals a block of character content.

Parameters: chars a char[] containing the characters start the starting index into the char[] length the number of characters

comment

public void comment(String data)
Signals to recieve a comment.

Parameters: data, the content of the comment

declareNamespace

public void declareNamespace(String prefix, String uri)
Declares the given namespace, the namespace will be added to the next element.

endElement

public void endElement(String name, String nsURI)
Signals the end of the current element.

Parameters: name the name of the element

entityReference

public void entityReference(String name)
Signals to recieve an entity reference with the given name.

Parameters: name the name of the entity reference

flush

public void flush()
The processor state doesn't always send data to the Formatter, until necessary. This method will force a "flush" of any saved data.

getResultHandler

public ResultHandler getResultHandler()
Returns the ResultHandler being used by this ResultFormatter.

Returns: the ResultHandler being used by this ResultFormatter

ignorableWhitespace

public void ignorableWhitespace(char[] chars, int start, int length)
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

isNamespaceDeclared

public boolean isNamespaceDeclared(String namespace)
Returns true if the given namespace has been declared.

Parameters: namespace the namespace to check the declaration for

Returns: true if the given namespace has been declared

processingInstruction

public void processingInstruction(String target, String data)
Signals to receive the processing instruction.

Parameters: target data

startElement

public void startElement(String name, String nsURI)
Signals the start of an element.

Parameters: name the name of the element, this must be the local name of the element. Any prefixes will be automatically stripped.

unescapedCharacters

public void unescapedCharacters(String data)
Signals to receive characters which should not be escaped.

Parameters: data the character data to receive

unescapedCharacters

public void unescapedCharacters(char[] chars, int start, int length)
Signals to receive characters which should not be escaped.

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