org.apache.xalan.transformer
Class ResultTreeHandler

java.lang.Object
  |
  +--org.apache.xalan.transformer.QueuedEvents
        |
        +--org.apache.xalan.transformer.ResultTreeHandler

public class ResultTreeHandler

extends org.apache.xalan.transformer.QueuedEvents

implements ContentHandler, LexicalHandler

This class is a layer between the direct calls to the result tree content handler, and the transformer. For one thing, we have to delay the call to getContentHandler().startElement(name, atts) because of the xsl:attribute and xsl:copy calls. In other words, the attributes have to be fully collected before you can call startElement.

Field Summary

ClonerToResultTree

m_cloner This class clones nodes to the result tree.

Constructor Summary

ResultTreeHandler()
Null constructor for object pooling.

ResultTreeHandler(TransformerImpl transformer, ContentHandler realHandler)
Create a new result tree handler.

Method Summary

void	addAttribute(Attr attr) Copy an DOM attribute to the created output element, executing attribute templates as need be, and processing the xsl:use attribute.
void	addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String rawName, java.lang.String type, java.lang.String value) Add an attribute to the end of the list.
void	addAttributes(Node src) Copy DOM attributes to the result element.
void	characters(char[] ch, int start, int length) Bottleneck the characters event.
void	cloneToResultTree(Node node, boolean shouldCloneAttributes) Clone an element with or without children.
void	comment(char[] ch, int start, int length) Bottleneck the comment event.
void	comment(java.lang.String data) Bottleneck the comment event.
void	endCDATA() End the CDATA characters.
void	endDocument() Bottleneck the endDocument event.
void	endDTD() End the DTD.
void	endElement(java.lang.String ns, java.lang.String localName, java.lang.String name) Bottleneck the endElement event.
void	endEntity(java.lang.String name) End an entity.
void	endPrefixMapping(java.lang.String prefix) End the scope of a prefix-URI mapping.
void	entityReference(java.lang.String name) Entity reference event.
void	flushPending() Flush the pending element.
void	flushPending(int type) Flush the pending element.
ContentHandler	getContentHandler() Return the current content handler.
NamespaceSupport	getNamespaceSupport() Get the NamespaceSupport object.
java.lang.String	getNewUniqueNSPrefix() Get new unique namespace prefix.
MutableAttrListImpl	getPendingAttributes() Get the pending attributes.
java.lang.String	getPrefix(java.lang.String namespace) Given a namespace, try and find a prefix.
int	getUniqueNSValue() Get a unique namespace value.
java.lang.String	getURI(java.lang.String prefix) Given a prefix, return the namespace,
void	ignorableWhitespace(char[] ch, int start, int length) Bottleneck the ignorableWhitespace event.
void	init(TransformerImpl transformer, ContentHandler realHandler) Initializer method.
boolean	isDefinedNSDecl(Attr attr) Returns whether a namespace is defined
boolean	isDefinedNSDecl(java.lang.String rawName, java.lang.String value) Return whether or not a namespace declaration is defined
boolean	isElementPending() Tell if an element is pending, to be output to the result tree.
void	outputResultTreeFragment(XObject obj, XPathContext support) Given a result tree fragment, walk the tree and output it to the result stream.
void	processingInstruction(java.lang.String target, java.lang.String data) Bottleneck the processingInstruction event.
void	processNSDecls(Node src) Copy xmlns: attributes in if not already in scope.
void	setContentHandler(ContentHandler ch) Set the current content handler.
void	setDocumentLocator(Locator locator) To fullfill the FormatterListener interface...
void	skippedEntity(java.lang.String name) Receive notification of a skipped entity.
void	startCDATA() Start the CDATACharacters.
void	startDocument() Bottleneck the startDocument event.
void	startDTD(java.lang.String s1, java.lang.String s2, java.lang.String s3) Start the DTD.
void	startElement(java.lang.String ns, java.lang.String localName, java.lang.String name) Bottleneck the startElement event.
void	startElement(java.lang.String ns, java.lang.String localName, java.lang.String name, Attributes atts) Bottleneck the startElement event.
void	startEntity(java.lang.String name) Start an entity.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Begin the scope of a prefix-URI Namespace mapping.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri, boolean shouldFlush) Begin the scope of a prefix-URI Namespace mapping.

Methods inherited from class org.apache.xalan.transformer.QueuedEvents

reset

Methods inherited from class java.lang.Object

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

Field Detail

m_cloner

public ClonerToResultTree m_cloner

This class clones nodes to the result tree.

Constructor Detail

ResultTreeHandler

public ResultTreeHandler()

Null constructor for object pooling.

ResultTreeHandler

public ResultTreeHandler(TransformerImpl transformer,
                         ContentHandler realHandler)

Create a new result tree handler. The real content handler will be the ContentHandler passed as an argument.

Parameters:

transformer - non-null transformer instance

realHandler - Content Handler instance

Method Detail

init

public void init(TransformerImpl transformer,
                 ContentHandler realHandler)

Initializer method.

Parameters:

transformer - non-null transformer instance

realHandler - Content Handler instance

startDocument

public void startDocument()
                   throws SAXException

Bottleneck the startDocument event.

Specified by:

startDocument in interface ContentHandler

Throws:

SAXException -

endDocument

public void endDocument()
                 throws SAXException

Bottleneck the endDocument event. This may be called more than once in order to make sure the pending start document is called.

Specified by:

endDocument in interface ContentHandler

Throws:

SAXException -

startElement

public void startElement(java.lang.String ns,
                         java.lang.String localName,
                         java.lang.String name)
                  throws SAXException

Bottleneck the startElement event. This is used to "pend" an element, so that attributes can still be added to it before the real "startElement" is called on the result tree listener.

Parameters:

ns - Namespace URI of element

localName - Local part of qname of element

name - Name of element

Throws:

SAXException -

startElement

public void startElement(java.lang.String ns,
                         java.lang.String localName,
                         java.lang.String name,
                         Attributes atts)
                  throws SAXException

Bottleneck the startElement event. This is used to "pend" an element, so that attributes can still be added to it before the real "startElement" is called on the result tree listener.

Specified by:

startElement in interface ContentHandler

Parameters:

ns - Namespace URI of element

localName - Local part of qname of element

name - Name of element

atts - List of attributes for the element

Throws:

SAXException -

endElement

public void endElement(java.lang.String ns,
                       java.lang.String localName,
                       java.lang.String name)
                throws SAXException

Bottleneck the endElement event.

Specified by:

endElement in interface ContentHandler

Parameters:

ns - Namespace URI of element

localName - Local part of qname of element

name - Name of element

Throws:

SAXException -

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws SAXException

Begin the scope of a prefix-URI Namespace mapping.

The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the http://xml.org/sax/features/namespaces feature is true (the default).

There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.

Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each-other: all startPrefixMapping events will occur before the corresponding startElement event, and all endPrefixMapping events will occur after the corresponding endElement event, but their order is not guaranteed.

Specified by:

startPrefixMapping in interface ContentHandler

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

endPrefixMapping(java.lang.String), startElement(java.lang.String, java.lang.String, java.lang.String)

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri,
                               boolean shouldFlush)
                        throws SAXException

Begin the scope of a prefix-URI Namespace mapping.

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

shouldFlush - Indicate whether pending events needs to be flushed first

Throws:

SAXException - The client may throw an exception during processing.

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws SAXException

End the scope of a prefix-URI mapping.

See startPrefixMapping for details. This event will always occur after the corresponding endElement event, but the order of endPrefixMapping events is not otherwise guaranteed.

Specified by:

endPrefixMapping in interface ContentHandler

Parameters:

prefix - The prefix that was being mapping.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

startPrefixMapping(java.lang.String, java.lang.String), endElement(java.lang.String, java.lang.String, java.lang.String)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Bottleneck the characters event.

Specified by:

characters in interface ContentHandler

Parameters:

ch - Array of characters to process

start - start of characters in the array

length - Number of characters in the array

Throws:

SAXException -

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws SAXException

Bottleneck the ignorableWhitespace event.

Specified by:

ignorableWhitespace in interface ContentHandler

Parameters:

ch - Array of characters to process

start - start of characters in the array

length - Number of characters in the array

Throws:

SAXException -

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws SAXException

Bottleneck the processingInstruction event.

Specified by:

processingInstruction in interface ContentHandler

Parameters:

target - Processing instruction target name

data - Processing instruction data

Throws:

SAXException -

comment

public void comment(java.lang.String data)
             throws SAXException

Bottleneck the comment event.

Parameters:

data - Comment data

Throws:

SAXException -

comment

public void comment(char[] ch,
                    int start,
                    int length)
             throws SAXException

Bottleneck the comment event.

Specified by:

comment in interface LexicalHandler

Parameters:

ch - Character array with comment data

start - start of characters in the array

length - number of characters in the array

Throws:

SAXException -

entityReference

public void entityReference(java.lang.String name)
                     throws SAXException

Entity reference event.

Parameters:

name - Name of entity

Throws:

SAXException -

startEntity

public void startEntity(java.lang.String name)
                 throws SAXException

Start an entity.

Specified by:

startEntity in interface LexicalHandler

Parameters:

name - Name of the entity

Throws:

SAXException -

endEntity

public void endEntity(java.lang.String name)
               throws SAXException

End an entity.

Specified by:

endEntity in interface LexicalHandler

Parameters:

name - Name of the entity

Throws:

SAXException -

startDTD

public void startDTD(java.lang.String s1,
                     java.lang.String s2,
                     java.lang.String s3)
              throws SAXException

Start the DTD.

Specified by:

startDTD in interface LexicalHandler

Parameters:

s1 - The document type name.

s2 - The declared public identifier for the external DTD subset, or null if none was declared.

s3 - The declared system identifier for the external DTD subset, or null if none was declared.

Throws:

SAXException -

endDTD

public void endDTD()
            throws SAXException

End the DTD.

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException -

startCDATA

public void startCDATA()
                throws SAXException

Start the CDATACharacters.

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException -

endCDATA

public void endCDATA()
              throws SAXException

End the CDATA characters.

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException -

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws SAXException

Receive notification of a skipped entity.

The Parser will invoke this method once for each entity skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the http://xml.org/sax/features/external-general-entities and the http://xml.org/sax/features/external-parameter-entities properties.

Specified by:

skippedEntity in interface ContentHandler

Parameters:

name - The name of the skipped entity. If it is a parameter entity, the name will begin with '%'.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

flushPending

public void flushPending()
                  throws SAXException

Flush the pending element.

Throws:

SAXException -

flushPending

public void flushPending(int type)
                  throws SAXException

Flush the pending element.

Parameters:

type - Event type

Throws:

SAXException -

outputResultTreeFragment

public void outputResultTreeFragment(XObject obj,
                                     XPathContext support)
                              throws SAXException

Given a result tree fragment, walk the tree and output it to the result stream.

Parameters:

obj - Result tree fragment object

support - XPath context for the result tree fragment

Throws:

SAXException -

cloneToResultTree

public void cloneToResultTree(Node node,
                              boolean shouldCloneAttributes)
                       throws SAXException

Clone an element with or without children.

Parameters:

node - Element to clone

shouldCloneAttributes - Whether or not to clone with children

Throws:

SAXException -

setDocumentLocator

public void setDocumentLocator(Locator locator)

To fullfill the FormatterListener interface... no action for the moment.

Specified by:

setDocumentLocator in interface ContentHandler

Parameters:

locator - Document locator

processNSDecls

public void processNSDecls(Node src)
                    throws TransformerException

Copy xmlns: attributes in if not already in scope.

Parameters:

src - Source Node

Throws:

TransformerException -

getURI

public java.lang.String getURI(java.lang.String prefix)

Given a prefix, return the namespace,

Parameters:

prefix - Given prefix name

Returns:

Namespace associated with the given prefix, or null

getPrefix

public java.lang.String getPrefix(java.lang.String namespace)

Given a namespace, try and find a prefix.

Parameters:

namespace - Given namespace URI

Returns:

Prefix name associated with namespace URI

getNamespaceSupport

public NamespaceSupport getNamespaceSupport()

Get the NamespaceSupport object.

Returns:

NamespaceSupport object.

getContentHandler

public ContentHandler getContentHandler()

Return the current content handler.

Returns:

The current content handler, or null if none has been registered.

See Also:

setContentHandler(org.xml.sax.ContentHandler)

setContentHandler

public void setContentHandler(ContentHandler ch)

Set the current content handler.

Parameters:

ch - Content Handler to be set

Returns:

The current content handler, or null if none has been registered.

See Also:

getContentHandler()

getUniqueNSValue

public int getUniqueNSValue()

Get a unique namespace value.

Returns:

a unique namespace value to be used with a fabricated prefix

getNewUniqueNSPrefix

public java.lang.String getNewUniqueNSPrefix()

Get new unique namespace prefix.

Returns:

Unique fabricated prefix.

getPendingAttributes

public MutableAttrListImpl getPendingAttributes()

Get the pending attributes. We have to delay the call to m_flistener.startElement(name, atts) because of the xsl:attribute and xsl:copy calls. In other words, the attributes have to be fully collected before you can call startElement.

Returns:

the pending attributes.

addAttribute

public void addAttribute(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String rawName,
                         java.lang.String type,
                         java.lang.String value)
                  throws TransformerException

Add an attribute to the end of the list.

Do not pass in xmlns decls to this function!

For the sake of speed, this method does no checking to see if the attribute is already in the list: that is the responsibility of the application.

Parameters:

uri - The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.

localName - The local name, or the empty string if Namespace processing is not being performed.

rawName - The raw XML 1.0 name, or the empty string if raw names are not available.

type - The attribute type as a string.

value - The attribute value.

Throws:

TransformerException -

isDefinedNSDecl

public boolean isDefinedNSDecl(java.lang.String rawName,
                               java.lang.String value)

Return whether or not a namespace declaration is defined

Parameters:

rawName - Raw name of namespace element

value - URI of given namespace

Returns:

True if the namespace is already defined in list of namespaces

isDefinedNSDecl

public boolean isDefinedNSDecl(Attr attr)

Returns whether a namespace is defined

Parameters:

attr - Namespace attribute node

Returns:

True if the namespace is already defined in list of namespaces

addAttribute

public void addAttribute(Attr attr)
                  throws TransformerException

Copy an DOM attribute to the created output element, executing attribute templates as need be, and processing the xsl:use attribute.

Parameters:

attr - Attribute node to add to result tree

Throws:

TransformerException -

addAttributes

public void addAttributes(Node src)
                   throws TransformerException

Copy DOM attributes to the result element.

Parameters:

src - Source node with the attributes

Throws:

TransformerException -

isElementPending

public boolean isElementPending()

Tell if an element is pending, to be output to the result tree.

Returns:

True if an element is pending