org.apache.xalan.templates

Class ElemTemplateElement

public class ElemTemplateElement extends UnImplNode implements PrefixResolver, Serializable, ExpressionNode, WhitespaceStrippingElementMatcher, XSLTVisitable

An instance of this class represents an element inside an xsl:template class. It has a single "execute" method which is expected to perform the given action on the result tree. This class acts like a Element node, and implements the Element interface, but is not a full implementation of that interface... it only implements enough for basic traversal of the tree.

See Also: Stylesheet

UNKNOWN: advanced

Constructor Summary
ElemTemplateElement()
Construct a template element instance.
Method Summary
NodeappendChild(Node newChild)
Add a child to the child list.
ElemTemplateElementappendChild(ElemTemplateElement elem)
Add a child to the child list.
voidcallVisitors(XSLTVisitor visitor)
booleancanAcceptVariables()
Tell if this element can accept variable declarations.
booleancanStripWhiteSpace()
Get information about whether or not whitespace can be stripped.
intcompareTo(Object o)
Compares this object with the specified object for precedence order.
voidcompose(StylesheetRoot sroot)
This function is called after everything else has been recomposed, and allows the template to set remaining values that may be based on some other property that depends on recomposition.
booleancontainsExcludeResultPrefix(String prefix, String uri)
Get whether or not the passed URL is contained flagged by the "extension-element-prefixes" property.
voidendCompose(StylesheetRoot sroot)
This after the template's children have been composed.
voiderror(String msg, Object[] args)
Throw a template element runtime error.
voiderror(String msg)
voidexecute(TransformerImpl transformer)
Execute the element's primary function.
voidexprAddChild(ExpressionNode n, int i)
This method tells the node to add its argument to the node's list of children.
ExpressionNodeexprGetChild(int i)
This method returns a child node.
intexprGetNumChildren()
Return the number of children the node has.
ExpressionNodeexprGetParent()
Get the ExpressionNode parent of this node.
voidexprSetParent(ExpressionNode n)
Set the parent of this node.
StringgetBaseIdentifier()
Return the base identifier.
NodeListgetChildNodes()
Return the nodelist (same reference).
intgetColumnNumber()
Return the column number where the current document event ends.
VectorgetDeclaredPrefixes()
Return a table that contains all prefixes available within this element context.
NodegetDOMBackPointer()
If this stylesheet was created from a DOM, get the DOM backpointer that this element originated from.
intgetEndColumnNumber()
Return the column number where the current document event ends.
intgetEndLineNumber()
Return the line number where the current document event ends.
NodegetFirstChild()
Get the first child as a Node.
ElemTemplateElementgetFirstChildElem()
Get the first child as a ElemTemplateElement.
NodegetLastChild()
Get the last child.
ElemTemplateElementgetLastChildElem()
Get the last child.
intgetLength()
NodeList method: Count the immediate children of this node
intgetLineNumber()
Return the line number where the current document event ends.
StringgetLocalName()
For now, just return the result of getNodeName(), which the local name.
StringgetNamespaceForPrefix(String prefix, Node context)
Fullfill the PrefixResolver interface.
StringgetNamespaceForPrefix(String prefix)
Given a namespace, get the corrisponding prefix.
NodegetNextSibling()
Get the next sibling (as a Node) or return null.
ElemTemplateElementgetNextSiblingElem()
Get the next sibling (as a ElemTemplateElement) or return null.
StringgetNodeName()
Return the node name.
shortgetNodeType()
Get the type of the node.
DocumentgetOwnerDocument()
Get the stylesheet owner.
ElemTemplategetOwnerXSLTemplate()
Get the owning xsl:template element.
ElemTemplateElementgetParentElem()
Get the parent as an ElemTemplateElement.
NodegetParentNode()
Get the parent as a Node.
ElemTemplateElementgetParentNodeElem()
Get the parent element.
VectorgetPrefixes()
Return a table that contains all prefixes available within this element context.
NodegetPreviousSibling()
Get the previous sibling (as a Node) or return null.
ElemTemplateElementgetPreviousSiblingElem()
Get the previous sibling (as a Node) or return null.
StringgetPublicId()
Return the public identifier for the current document event.
StylesheetgetStylesheet()
Get the owning stylesheet.
StylesheetComposedgetStylesheetComposed()
Get the owning "composed" stylesheet.
StylesheetRootgetStylesheetRoot()
Get the owning root stylesheet.
StringgetSystemId()
Return the system identifier for the current document event.
StringgetTagName()
Return the element name.
intgetUid()
Get the UID (document order index).
booleangetXmlSpace()
Get the "xml:space" attribute.
intgetXSLToken()
Get an integer representation of the element type.
booleanhandlesNullPrefixes()
booleanhasChildNodes()
Tell if there are child nodes.
booleanhasTextLitOnly()
Tell if this element only has one text child, for optimization purposes.
booleanhasVariableDecl()
NodeinsertBefore(Node newChild, Node refChild)
Unimplemented.
booleanisCompiledTemplate()
Tell if this template is a compiled template.
Nodeitem(int index)
NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
voidrecompose(StylesheetRoot root)
This function is called during recomposition to control how this element is composed.
ElemTemplateElementremoveChild(ElemTemplateElement childETE)
Remove a child.
NodereplaceChild(Node newChild, Node oldChild)
Replace the old child with a new child.
ElemTemplateElementreplaceChild(ElemTemplateElement newChildElem, ElemTemplateElement oldChildElem)
Replace the old child with a new child.
voidresolvePrefixTables()
Combine the parent's namespaces with this namespace for fast processing, taking care to reference the parent's namespace if this namespace adds nothing new.
voidruntimeInit(TransformerImpl transformer)
This function will be called on top-level elements only, just before the transform begins.
voidsetDOMBackPointer(Node n)
If this stylesheet was created from a DOM, set the DOM backpointer that this element originated from.
voidsetEndLocaterInfo(SourceLocator locator)
Set the end location information for this element.
voidsetLocaterInfo(SourceLocator locator)
Set the location information for this element.
voidsetParentElem(ElemTemplateElement p)
Set the parent as an ElemTemplateElement.
voidsetPrefixes(NamespaceSupport nsSupport)
From the SAX2 helper class, set the namespace table for this element.
voidsetPrefixes(NamespaceSupport nsSupport, boolean excludeXSLDecl)
Copy the namespace declarations from the NamespaceSupport object.
voidsetUid(int i)
Set the UID (document order index).
voidsetXmlSpace(int v)
Set the "xml:space" attribute.
booleanshouldStripWhiteSpace(XPathContext support, Element targetElement)
Get information about whether or not an element should strip whitespace.

Constructor Detail

ElemTemplateElement

public ElemTemplateElement()
Construct a template element instance.

Method Detail

appendChild

public Node appendChild(Node newChild)
Add a child to the child list. NOTE: This presumes the child did not previously have a parent. Making that assumption makes this a less expensive operation -- but requires that if you *do* want to reparent a node, you use removeChild() first to remove it from its previous context. Failing to do so will damage the tree.

Parameters: newChild Child to be added to child list

Returns: Child just added to the child list

Throws: DOMException

appendChild

public ElemTemplateElement appendChild(ElemTemplateElement elem)
Add a child to the child list. NOTE: This presumes the child did not previously have a parent. Making that assumption makes this a less expensive operation -- but requires that if you *do* want to reparent a node, you use removeChild() first to remove it from its previous context. Failing to do so will damage the tree.

Parameters: elem Child to be added to child list

Returns: Child just added to the child list

callVisitors

public void callVisitors(XSLTVisitor visitor)

See Also: callVisitors

canAcceptVariables

public boolean canAcceptVariables()
Tell if this element can accept variable declarations.

Returns: true if the element can accept and process variable declarations.

canStripWhiteSpace

public boolean canStripWhiteSpace()
Get information about whether or not whitespace can be stripped.

Returns: true if the whitespace can be stripped.

See Also: strip in XSLT Specification

compareTo

public int compareTo(Object o)
Compares this object with the specified object for precedence order. The order is determined by the getImportCountComposed() of the containing composed stylesheet and the getUid() of this element. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters: o The object to be compared to this object

Returns: a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws: ClassCastException if the specified object's type prevents it from being compared to this Object.

compose

public void compose(StylesheetRoot sroot)
This function is called after everything else has been recomposed, and allows the template to set remaining values that may be based on some other property that depends on recomposition.

containsExcludeResultPrefix

public boolean containsExcludeResultPrefix(String prefix, String uri)
Get whether or not the passed URL is contained flagged by the "extension-element-prefixes" property. This method is overridden by {@link ElemLiteralResult#containsExcludeResultPrefix}.

Parameters: prefix non-null reference to prefix that might be excluded.

Returns: true if the prefix should normally be excluded.

See Also: extension-element in XSLT Specification

endCompose

public void endCompose(StylesheetRoot sroot)
This after the template's children have been composed.

error

public void error(String msg, Object[] args)
Throw a template element runtime error. (Note: should we throw a TransformerException instead?)

Parameters: msg key of the error that occured. args Arguments to be used in the message

error

public void error(String msg)

execute

public void execute(TransformerImpl transformer)
Execute the element's primary function. Subclasses of this function may recursivly execute down the element tree.

Parameters: transformer The XSLT TransformerFactory.

Throws: TransformerException if any checked exception occurs.

exprAddChild

public void exprAddChild(ExpressionNode n, int i)
This method tells the node to add its argument to the node's list of children.

Parameters: n Must be a ElemTemplateElement.

exprGetChild

public ExpressionNode exprGetChild(int i)
This method returns a child node. The children are numbered from zero, left to right.

exprGetNumChildren

public int exprGetNumChildren()
Return the number of children the node has.

exprGetParent

public ExpressionNode exprGetParent()
Get the ExpressionNode parent of this node.

exprSetParent

public void exprSetParent(ExpressionNode n)
Set the parent of this node.

Parameters: n Must be a ElemTemplateElement.

getBaseIdentifier

public String getBaseIdentifier()
Return the base identifier.

Returns: The base identifier

getChildNodes

public NodeList getChildNodes()
Return the nodelist (same reference).

Returns: The nodelist containing the child nodes (this)

getColumnNumber

public int getColumnNumber()
Return the column number where the current document event ends. Note that this is the column number of the first character after the text associated with the document event. The first column in a line is position 1.

Returns: The column number, or -1 if none is available.

See Also: ElemTemplateElement

getDeclaredPrefixes

public Vector getDeclaredPrefixes()
Return a table that contains all prefixes available within this element context.

Returns: Vector containing the prefixes available within this element context

getDOMBackPointer

public Node getDOMBackPointer()
If this stylesheet was created from a DOM, get the DOM backpointer that this element originated from. For tooling use.

Returns: DOM backpointer that this element originated from or null.

getEndColumnNumber

public int getEndColumnNumber()
Return the column number where the current document event ends. Note that this is the column number of the first character after the text associated with the document event. The first column in a line is position 1.

Returns: The column number, or -1 if none is available.

See Also: ElemTemplateElement

getEndLineNumber

public int getEndLineNumber()
Return the line number where the current document event ends. Note that this is the line position of the first character after the text associated with the document event.

Returns: The line number, or -1 if none is available.

See Also: ElemTemplateElement

getFirstChild

public Node getFirstChild()
Get the first child as a Node.

Returns: This node's first child or null

getFirstChildElem

public ElemTemplateElement getFirstChildElem()
Get the first child as a ElemTemplateElement.

Returns: This node's first child (as a ElemTemplateElement) or null

getLastChild

public Node getLastChild()
Get the last child.

Returns: This node's last child

getLastChildElem

public ElemTemplateElement getLastChildElem()
Get the last child.

Returns: This node's last child

getLength

public int getLength()
NodeList method: Count the immediate children of this node

Returns: The count of children of this node

getLineNumber

public int getLineNumber()
Return the line number where the current document event ends. Note that this is the line position of the first character after the text associated with the document event.

Returns: The line number, or -1 if none is available.

See Also: ElemTemplateElement

getLocalName

public String getLocalName()
For now, just return the result of getNodeName(), which the local name.

Returns: The result of getNodeName().

getNamespaceForPrefix

public String getNamespaceForPrefix(String prefix, Node context)
Fullfill the PrefixResolver interface. Calling this for this class will throw an error.

Parameters: prefix The prefix to look up, which may be an empty string ("") for the default Namespace. context The node context from which to look up the URI.

Returns: null if the error listener does not choose to throw an exception.

getNamespaceForPrefix

public String getNamespaceForPrefix(String prefix)
Given a namespace, get the corrisponding prefix. 9/15/00: This had been iteratively examining the m_declaredPrefixes field for this node and its parents. That makes life difficult for the compilation experiment, which doesn't have a static vector of local declarations. Replaced a recursive solution, which permits easier subclassing/overriding.

Parameters: prefix non-null reference to prefix string, which should map to a namespace URL.

Returns: The namespace URL that the prefix maps to, or null if no mapping can be found.

getNextSibling

public Node getNextSibling()
Get the next sibling (as a Node) or return null.

Returns: this node's next sibling or null

getNextSiblingElem

public ElemTemplateElement getNextSiblingElem()
Get the next sibling (as a ElemTemplateElement) or return null.

Returns: This node's next sibling (as a ElemTemplateElement) or null

getNodeName

public String getNodeName()
Return the node name.

Returns: An invalid node name

getNodeType

public short getNodeType()
Get the type of the node.

Returns: Constant for this node type

getOwnerDocument

public Document getOwnerDocument()
Get the stylesheet owner.

Returns: The stylesheet owner

getOwnerXSLTemplate

public ElemTemplate getOwnerXSLTemplate()
Get the owning xsl:template element.

Returns: The owning xsl:template element, this element if it is a xsl:template, or null if not found.

getParentElem

public ElemTemplateElement getParentElem()
Get the parent as an ElemTemplateElement.

Returns: This node's parent as an ElemTemplateElement

getParentNode

public Node getParentNode()
Get the parent as a Node.

Returns: This node's parent node

getParentNodeElem

public ElemTemplateElement getParentNodeElem()
Get the parent element.

Returns: This node's next parent (as a ElemTemplateElement) or null

getPrefixes

public Vector getPrefixes()
Return a table that contains all prefixes available within this element context.

Returns: reference to vector of {@link XMLNSDecl}s, which may be null.

getPreviousSibling

public Node getPreviousSibling()
Get the previous sibling (as a Node) or return null. Note that this may be expensive if the parent has many kids; we accept that price in exchange for avoiding the prev pointer TODO: If we were sure parents and sibs are always ElemTemplateElements, we could hit the fields directly rather than thru accessors.

Returns: This node's previous sibling or null

getPreviousSiblingElem

public ElemTemplateElement getPreviousSiblingElem()
Get the previous sibling (as a Node) or return null. Note that this may be expensive if the parent has many kids; we accept that price in exchange for avoiding the prev pointer TODO: If we were sure parents and sibs are always ElemTemplateElements, we could hit the fields directly rather than thru accessors.

Returns: This node's previous sibling or null

getPublicId

public String getPublicId()
Return the public identifier for the current document event.

This will be the public identifier

Returns: A string containing the public identifier, or null if none is available.

See Also: ElemTemplateElement

getStylesheet

public Stylesheet getStylesheet()
Get the owning stylesheet. This looks up the inheritance chain until it calls getStylesheet on a Stylesheet object, which will return itself.

Returns: the owning stylesheet

getStylesheetComposed

public StylesheetComposed getStylesheetComposed()
Get the owning "composed" stylesheet. This looks up the inheritance chain until it calls getStylesheetComposed on a Stylesheet object, which will Get the owning aggregated stylesheet, or that stylesheet if it is aggregated.

Returns: the owning "composed" stylesheet.

getStylesheetRoot

public StylesheetRoot getStylesheetRoot()
Get the owning root stylesheet. This looks up the inheritance chain until it calls StylesheetRoot on a Stylesheet object, which will return a reference to the root stylesheet.

Returns: the owning root stylesheet

getSystemId

public String getSystemId()
Return the system identifier for the current document event.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Returns: A string containing the system identifier, or null if none is available.

See Also: ElemTemplateElement

getTagName

public String getTagName()
Return the element name.

Returns: The element name

getUid

public int getUid()
Get the UID (document order index).

Returns: Index of this child

getXmlSpace

public boolean getXmlSpace()
Get the "xml:space" attribute. A text node is preserved if an ancestor element of the text node has an xml:space attribute with a value of preserve, and no closer ancestor element has xml:space with a value of default.

Returns: The value of the xml:space attribute

See Also: strip in XSLT Specification section-Creating-Text in XSLT Specification

getXSLToken

public int getXSLToken()
Get an integer representation of the element type.

Returns: An integer representation of the element, defined in the Constants class.

See Also: Constants

handlesNullPrefixes

public boolean handlesNullPrefixes()

See Also: handlesNullPrefixes

hasChildNodes

public boolean hasChildNodes()
Tell if there are child nodes.

Returns: True if there are child nodes

hasTextLitOnly

public boolean hasTextLitOnly()
Tell if this element only has one text child, for optimization purposes.

Returns: true of this element only has one text literal child.

hasVariableDecl

public boolean hasVariableDecl()

insertBefore

public Node insertBefore(Node newChild, Node refChild)
Unimplemented. See org.w3c.dom.Node

Parameters: newChild New child node to insert refChild Insert in front of this child

Returns: null

Throws: DOMException

isCompiledTemplate

public boolean isCompiledTemplate()
Tell if this template is a compiled template.

Returns: Boolean flag indicating whether this is a compiled template

item

public Node item(int index)
NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.

Parameters: index Index of child to find

Returns: org.w3c.dom.Node: the child node at given index

recompose

public void recompose(StylesheetRoot root)
This function is called during recomposition to control how this element is composed.

removeChild

public ElemTemplateElement removeChild(ElemTemplateElement childETE)
Remove a child. ADDED 9/8/200 to support compilation. TODO: ***** Alternative is "removeMe() from my parent if any" ... which is less well checked, but more convenient in some cases. Given that we assume only experts are calling this class, it might be preferable. It's less DOMish, though.

Parameters: childETE The child to remove. This operation is a no-op if oldChild is not a child of this node.

Returns: the removed child, or null if the specified node was not a child of this element.

replaceChild

public Node replaceChild(Node newChild, Node oldChild)
Replace the old child with a new child.

Parameters: newChild New child to replace with oldChild Old child to be replaced

Returns: The new child

Throws: DOMException

replaceChild

public ElemTemplateElement replaceChild(ElemTemplateElement newChildElem, ElemTemplateElement oldChildElem)
Replace the old child with a new child.

Parameters: newChildElem New child to replace with oldChildElem Old child to be replaced

Returns: The new child

Throws: DOMException

resolvePrefixTables

public void resolvePrefixTables()
Combine the parent's namespaces with this namespace for fast processing, taking care to reference the parent's namespace if this namespace adds nothing new. (Recursive method, walking the elements depth-first, processing parents before children). Note that this method builds m_prefixTable with aliased namespaces, *not* the original namespaces.

Throws: TransformerException

runtimeInit

public void runtimeInit(TransformerImpl transformer)
This function will be called on top-level elements only, just before the transform begins.

Parameters: transformer The XSLT TransformerFactory.

Throws: TransformerException

setDOMBackPointer

public void setDOMBackPointer(Node n)
If this stylesheet was created from a DOM, set the DOM backpointer that this element originated from. For tooling use.

Parameters: n DOM backpointer that this element originated from.

setEndLocaterInfo

public void setEndLocaterInfo(SourceLocator locator)
Set the end location information for this element.

Parameters: locator Source Locator with location information for this element

setLocaterInfo

public void setLocaterInfo(SourceLocator locator)
Set the location information for this element.

Parameters: locator Source Locator with location information for this element

setParentElem

public void setParentElem(ElemTemplateElement p)
Set the parent as an ElemTemplateElement.

Parameters: p This node's parent as an ElemTemplateElement

setPrefixes

public void setPrefixes(NamespaceSupport nsSupport)
From the SAX2 helper class, set the namespace table for this element. Take care to call resolveInheritedNamespaceDecls. after all namespace declarations have been added.

Parameters: nsSupport non-null reference to NamespaceSupport from the ContentHandler.

Throws: TransformerException

setPrefixes

public void setPrefixes(NamespaceSupport nsSupport, boolean excludeXSLDecl)
Copy the namespace declarations from the NamespaceSupport object. Take care to call resolveInheritedNamespaceDecls. after all namespace declarations have been added.

Parameters: nsSupport non-null reference to NamespaceSupport from the ContentHandler. excludeXSLDecl true if XSLT namespaces should be ignored.

Throws: TransformerException

setUid

public void setUid(int i)
Set the UID (document order index).

Parameters: i Index of this child.

setXmlSpace

public void setXmlSpace(int v)
Set the "xml:space" attribute. A text node is preserved if an ancestor element of the text node has an xml:space attribute with a value of preserve, and no closer ancestor element has xml:space with a value of default.

Parameters: v Enumerated value, either Constants.ATTRVAL_PRESERVE or Constants.ATTRVAL_STRIP.

See Also: strip in XSLT Specification section-Creating-Text in XSLT Specification

shouldStripWhiteSpace

public boolean shouldStripWhiteSpace(XPathContext support, Element targetElement)
Get information about whether or not an element should strip whitespace.

Parameters: support The XPath runtime state. targetElement Element to check

Returns: true if the whitespace should be stripped.

Throws: TransformerException

See Also: strip in XSLT Specification

Copyright B) 2005 Apache XML Project. All Rights Reserved.