Package org.apache.xalan.templates

Class ElemTemplateElement

java.lang.Object
org.apache.xml.utils.UnImplNode
org.apache.xalan.templates.ElemTemplateElement
All Implemented Interfaces:
Serializable, SourceLocator, XSLTVisitable, PrefixResolver, ExpressionNode, WhitespaceStrippingElementMatcher, Document, Element, Node, NodeList
Direct Known Subclasses:
DecimalFormatProperties, ElemApplyImport, ElemChoose, ElemComment, ElemCopyOf, ElemEmpty, ElemExtensionDecl, ElemExtensionScript, ElemFallback, ElemForEach, ElemIf, ElemMessage, ElemNumber, ElemOtherwise, ElemPI, ElemSort, ElemTemplate, ElemText, ElemTextLiteral, ElemUse, ElemValueOf, ElemVariable, ElemWhen, ElemWithParam, KeyDeclaration, NamespaceAlias, OutputProperties, Stylesheet, XSLTElementProcessor
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, Serialized Form

  • Field Details

    • m_hasVariableDecl

      protected boolean m_hasVariableDecl
      Tell if this element only has one text child, for optimization purposes.

    • m_docOrderNumber

      protected int m_docOrderNumber
      The *relative* document order number of this element.

    • m_parentNode

      protected ElemTemplateElement m_parentNode
      Parent node.

  • Constructor Details

    • ElemTemplateElement

      public ElemTemplateElement()
      Construct a template element instance.

  • Method Details

    • isCompiledTemplate

      public boolean isCompiledTemplate()
      Tell if this template is a compiled template.
      Returns:
      Boolean flag indicating whether this is a compiled template

    • 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

    • getNodeName

      public String getNodeName()
      Return the node name.
      Specified by:
      getNodeName in interface Node
      Overrides:
      getNodeName in class UnImplNode
      Returns:
      An invalid node name

    • getLocalName

      public String getLocalName()
      For now, just return the result of getNodeName(), which the local name.
      Specified by:
      getLocalName in interface Node
      Overrides:
      getLocalName in class UnImplNode
      Returns:
      The result of getNodeName().

    • runtimeInit

      public void runtimeInit​(TransformerImpl transformer) throws TransformerException
      This function will be called on top-level elements only, just before the transform begins.
      Parameters:
      transformer - The XSLT TransformerFactory.
      Throws:
      TransformerException

    • execute

      public void execute​(TransformerImpl transformer) throws TransformerException
      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.

    • 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.

    • 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

    • 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

    • recompose

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

    • compose

      public void compose​(StylesheetRoot sroot) throws TransformerException
      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.
      Throws:
      TransformerException

    • endCompose

      public void endCompose​(StylesheetRoot sroot) throws TransformerException
      This after the template's children have been composed.
      Throws:
      TransformerException

    • error

      public void error​(String msg, Object[] args)
      Throw a template element runtime error. (Note: should we throw a TransformerException instead?)
      Overrides:
      error in class UnImplNode
      Parameters:
      msg - key of the error that occured.
      args - Arguments to be used in the message

    • error

      public void error​(String msg)
      Description copied from class: UnImplNode
      Throw an error.
      Overrides:
      error in class UnImplNode
      Parameters:
      msg - Message Key for the error

    • appendChild

      public Node appendChild​(Node newChild) throws DOMException
      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.
      Specified by:
      appendChild in interface Node
      Overrides:
      appendChild in class UnImplNode
      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

    • hasChildNodes

      public boolean hasChildNodes()
      Tell if there are child nodes.
      Specified by:
      hasChildNodes in interface Node
      Overrides:
      hasChildNodes in class UnImplNode
      Returns:
      True if there are child nodes

    • getNodeType

      public short getNodeType()
      Get the type of the node.
      Specified by:
      getNodeType in interface Node
      Overrides:
      getNodeType in class UnImplNode
      Returns:
      Constant for this node type

    • getChildNodes

      public NodeList getChildNodes()
      Return the nodelist (same reference).
      Specified by:
      getChildNodes in interface Node
      Overrides:
      getChildNodes in class UnImplNode
      Returns:
      The nodelist containing the child nodes (this)

    • 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) throws DOMException
      Replace the old child with a new child.
      Specified by:
      replaceChild in interface Node
      Overrides:
      replaceChild in class UnImplNode
      Parameters:
      newChild - New child to replace with
      oldChild - Old child to be replaced
      Returns:
      The new child
      Throws:
      DOMException

    • insertBefore

      public Node insertBefore​(Node newChild, Node refChild) throws DOMException
      Unimplemented. See org.w3c.dom.Node
      Specified by:
      insertBefore in interface Node
      Overrides:
      insertBefore in class UnImplNode
      Parameters:
      newChild - New child node to insert
      refChild - Insert in front of this child
      Returns:
      null
      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

    • getLength

      public int getLength()
      NodeList method: Count the immediate children of this node
      Specified by:
      getLength in interface NodeList
      Overrides:
      getLength in class UnImplNode
      Returns:
      The count of children of this node

    • 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.
      Specified by:
      item in interface NodeList
      Overrides:
      item in class UnImplNode
      Parameters:
      index - Index of child to find
      Returns:
      org.w3c.dom.Node: the child node at given index

    • getOwnerDocument

      public Document getOwnerDocument()
      Get the stylesheet owner.
      Specified by:
      getOwnerDocument in interface Node
      Overrides:
      getOwnerDocument in class UnImplNode
      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.

    • getTagName

      public String getTagName()
      Return the element name.
      Specified by:
      getTagName in interface Element
      Overrides:
      getTagName in class UnImplNode
      Returns:
      The element name

    • 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.

    • getBaseIdentifier

      public String getBaseIdentifier()
      Return the base identifier.
      Specified by:
      getBaseIdentifier in interface PrefixResolver
      Returns:
      The base identifier

    • 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:
      getColumnNumber()

    • 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.
      Specified by:
      getLineNumber in interface SourceLocator
      Returns:
      The line number, or -1 if none is available.
      See Also:
      getColumnNumber()

    • 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:
      getLineNumber()

    • 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.
      Specified by:
      getColumnNumber in interface SourceLocator
      Returns:
      The column number, or -1 if none is available.
      See Also:
      getLineNumber()

    • getPublicId

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

      This will be the public identifier

      Specified by:
      getPublicId in interface SourceLocator
      Returns:
      A string containing the public identifier, or null if none is available.
      See Also:
      getSystemId()

    • 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.

      Specified by:
      getSystemId in interface SourceLocator
      Returns:
      A string containing the system identifier, or null if none is available.
      See Also:
      getPublicId()

    • setLocaterInfo

      public void setLocaterInfo​(SourceLocator locator)
      Set the location information for this element.
      Parameters:
      locator - Source Locator with location information for this element

    • setEndLocaterInfo

      public void setEndLocaterInfo​(SourceLocator locator)
      Set the end location information for this element.
      Parameters:
      locator - Source Locator with location information for this element

    • hasVariableDecl

      public boolean hasVariableDecl()

    • 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

    • 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

    • getDeclaredPrefixes

      public List getDeclaredPrefixes()
      Return a table that contains all prefixes available within this element context.
      Returns:
      Vector containing the prefixes available within this element context

    • setPrefixes

      public void setPrefixes​(NamespaceSupport nsSupport) throws TransformerException
      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) throws TransformerException
      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

    • getNamespaceForPrefix

      public String getNamespaceForPrefix​(String prefix, Node context)
      Fullfill the PrefixResolver interface. Calling this for this class will throw an error.
      Specified by:
      getNamespaceForPrefix in interface PrefixResolver
      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.
      Specified by:
      getNamespaceForPrefix in interface PrefixResolver
      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.

    • 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 ElemLiteralResult.containsExcludeResultPrefix(java.lang.String, java.lang.String).
      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

    • resolvePrefixTables

      public void resolvePrefixTables() throws TransformerException
      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

    • setUid

      public void setUid​(int i)
      Set the UID (document order index).
      Parameters:
      i - Index of this child.

    • getUid

      public int getUid()
      Get the UID (document order index).
      Returns:
      Index of this child

    • getParentNode

      public Node getParentNode()
      Get the parent as a Node.
      Specified by:
      getParentNode in interface Node
      Overrides:
      getParentNode in class UnImplNode
      Returns:
      This node's parent node

    • getParentElem

      public ElemTemplateElement getParentElem()
      Get the parent as an ElemTemplateElement.
      Returns:
      This node's parent as an ElemTemplateElement

    • setParentElem

      public void setParentElem​(ElemTemplateElement p)
      Set the parent as an ElemTemplateElement.
      Parameters:
      p - This node's parent as an ElemTemplateElement

    • getNextSibling

      public Node getNextSibling()
      Get the next sibling (as a Node) or return null.
      Specified by:
      getNextSibling in interface Node
      Overrides:
      getNextSibling in class UnImplNode
      Returns:
      this node's next sibling or 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.
      Specified by:
      getPreviousSibling in interface Node
      Overrides:
      getPreviousSibling in class UnImplNode
      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

    • 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

    • getParentNodeElem

      public ElemTemplateElement getParentNodeElem()
      Get the parent element.
      Returns:
      This node's next parent (as a ElemTemplateElement) or null

    • getFirstChild

      public Node getFirstChild()
      Get the first child as a Node.
      Specified by:
      getFirstChild in interface Node
      Overrides:
      getFirstChild in class UnImplNode
      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.
      Specified by:
      getLastChild in interface Node
      Overrides:
      getLastChild in class UnImplNode
      Returns:
      This node's last child

    • getLastChildElem

      public ElemTemplateElement getLastChildElem()
      Get the last child.
      Returns:
      This node's last child

    • 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.

    • 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.

    • compareTo

      public int compareTo​(Object o) throws ClassCastException
      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.

    • shouldStripWhiteSpace

      public boolean shouldStripWhiteSpace​(XPathContext support, Element targetElement) throws TransformerException
      Get information about whether or not an element should strip whitespace.
      Specified by:
      shouldStripWhiteSpace in interface WhitespaceStrippingElementMatcher
      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

    • canStripWhiteSpace

      public boolean canStripWhiteSpace()
      Get information about whether or not whitespace can be stripped.
      Specified by:
      canStripWhiteSpace in interface WhitespaceStrippingElementMatcher
      Returns:
      true if the whitespace can be stripped.
      See Also:
      strip in XSLT Specification

    • canAcceptVariables

      public boolean canAcceptVariables()
      Tell if this element can accept variable declarations.
      Returns:
      true if the element can accept and process variable declarations.

    • exprSetParent

      public void exprSetParent​(ExpressionNode n)
      Set the parent of this node.
      Specified by:
      exprSetParent in interface ExpressionNode
      Parameters:
      n - Must be a ElemTemplateElement.

    • exprGetParent

      public ExpressionNode exprGetParent()
      Get the ExpressionNode parent of this node.
      Specified by:
      exprGetParent in interface ExpressionNode

    • exprAddChild

      public void exprAddChild​(ExpressionNode n, int i)
      This method tells the node to add its argument to the node's list of children.
      Specified by:
      exprAddChild in interface ExpressionNode
      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.
      Specified by:
      exprGetChild in interface ExpressionNode

    • exprGetNumChildren

      public int exprGetNumChildren()
      Return the number of children the node has.
      Specified by:
      exprGetNumChildren in interface ExpressionNode

    • accept

      protected boolean accept​(XSLTVisitor visitor)
      Accept a visitor and call the appropriate method for this class.
      Parameters:
      visitor - The visitor whose appropriate method will be called.
      Returns:
      true if the children of the object should be visited.

    • callVisitors

      public void callVisitors​(XSLTVisitor visitor)
      Description copied from interface: XSLTVisitable
      This will traverse the heararchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called.
      Specified by:
      callVisitors in interface XSLTVisitable
      Parameters:
      visitor - The visitor whose appropriate method will be called.
      See Also:
      XSLTVisitable.callVisitors(XSLTVisitor)

    • callChildVisitors

      protected void callChildVisitors​(XSLTVisitor visitor, boolean callAttributes)
      Call the children visitors.
      Parameters:
      visitor - The visitor whose appropriate method will be called.

    • callChildVisitors

      protected void callChildVisitors​(XSLTVisitor visitor)
      Call the children visitors.
      Parameters:
      visitor - The visitor whose appropriate method will be called.

    • handlesNullPrefixes

      public boolean handlesNullPrefixes()
      Specified by:
      handlesNullPrefixes in interface PrefixResolver
      See Also:
      PrefixResolver.handlesNullPrefixes()