org.apache.xalan.templates
Class ElemNumber

java.lang.Object
  |
  +--org.apache.xml.utils.UnImplNode
        |
        +--org.apache.xalan.templates.ElemTemplateElement
              |
              +--org.apache.xalan.templates.ElemNumber

public class ElemNumber
extends ElemTemplateElement

Implement xsl:number.

 
 
 

See Also:
number in XSLT Specification, Serialized Form
Usage:
**For advanced use only**

Constructor Summary
ElemNumber()
           
 
Method Summary
 ElemTemplateElement appendChild(ElemTemplateElement newChild)
          Add a child to the child list.
 void callChildVisitors(XSLTVisitor visitor, boolean callAttrs)
          Call the children visitors.
 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.
 void execute(TransformerImpl transformer)
          Execute an xsl:number instruction.
 XPath getCount()
          Get the "count" attribute.
 AVT getFormat()
          Get the "format" attribute.
 XPath getFrom()
          Get the "from" attribute.
 AVT getGroupingSeparator()
          Get the "grouping-separator" attribute.
 AVT getGroupingSize()
          Get the "grouping-size" attribute.
 AVT getLang()
          Get the "lang" attribute.
 AVT getLetterValue()
          Get the "letter-value" attribute.
 int getLevel()
          Get the "level" attribute.
 java.lang.String getNodeName()
          Return the node name.
 int getPreviousNode(XPathContext xctxt, int pos)
          Get the previous node to be counted.
 int getTargetNode(XPathContext xctxt, int sourceNode)
          Get the target node that will be counted..
 XPath getValue()
          Get the "value" attribute.
 int getXSLToken()
          Get an int constant identifying the type of element.
 void setCount(XPath v)
          Set the "count" attribute.
 void setFormat(AVT v)
          Set the "format" attribute.
 void setFrom(XPath v)
          Set the "from" attribute.
 void setGroupingSeparator(AVT v)
          Set the "grouping-separator" attribute.
 void setGroupingSize(AVT v)
          Set the "grouping-size" attribute.
 void setLang(AVT v)
          Set the "lang" attribute.
 void setLetterValue(AVT v)
          Set the "letter-value" attribute.
 void setLevel(int v)
          Set the "level" attribute.
 void setValue(XPath v)
          Set the "value" attribute.
 
Methods inherited from class org.apache.xalan.templates.ElemTemplateElement
appendChild, callVisitors, canAcceptVariables, canStripWhiteSpace, compareTo, containsExcludeResultPrefix, endCompose, error, error, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getBaseIdentifier, getChildNodes, getColumnNumber, getDeclaredPrefixes, getDOMBackPointer, getEndColumnNumber, getEndLineNumber, getFirstChild, getFirstChildElem, getLastChild, getLastChildElem, getLength, getLineNumber, getLocalName, getNamespaceForPrefix, getNamespaceForPrefix, getNextSibling, getNextSiblingElem, getNodeType, getOwnerDocument, getOwnerXSLTemplate, getParentElem, getParentNode, getParentNodeElem, getPreviousSibling, getPreviousSiblingElem, getPublicId, getStylesheet, getStylesheetComposed, getStylesheetRoot, getSystemId, getTagName, getUid, getXmlSpace, handlesNullPrefixes, hasChildNodes, hasTextLitOnly, hasVariableDecl, insertBefore, isCompiledTemplate, item, recompose, removeChild, replaceChild, replaceChild, resolvePrefixTables, runtimeInit, setDOMBackPointer, setEndLocaterInfo, setLocaterInfo, setParentElem, setPrefixes, setPrefixes, setUid, setXmlSpace, shouldStripWhiteSpace
 
Methods inherited from class org.apache.xml.utils.UnImplNode
adoptNode, appendData, cloneNode, compareDocumentPosition, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, getActualEncoding, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getFeature, getImplementation, getInputEncoding, getNamespaceURI, getNodeValue, getOwnerElement, getPrefix, getSchemaTypeInfo, getSpecified, getStrictErrorChecking, getTextContent, getUserData, getWholeText, getXmlEncoding, getXmlStandalone, getXmlVersion, hasAttribute, hasAttributeNS, hasAttributes, importNode, insertData, isDefaultNamespace, isEqualNode, isId, isSameNode, isSupported, isWhitespaceInElementContent, lookupNamespaceURI, lookupPrefix, normalize, normalizeDocument, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, renameNode, replaceData, replaceWholeText, setActualEncoding, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setData, setDocumentURI, setIdAttribute, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setInputEncoding, setNodeValue, setPrefix, setStrictErrorChecking, setTextContent, setUserData, setValue, setXmlEncoding, setXmlStandalone, setXmlVersion, splitText, substringData
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ElemNumber

public ElemNumber()
Method Detail

setCount

public void setCount(XPath v)
Set the "count" attribute. The count attribute is a pattern that specifies what nodes should be counted at those levels. If count attribute is not specified, then it defaults to the pattern that matches any node with the same node type as the current node and, if the current node has an expanded-name, with the same expanded-name as the current node.
Parameters:
v - Value to set for "count" attribute.

getCount

public XPath getCount()
Get the "count" attribute. The count attribute is a pattern that specifies what nodes should be counted at those levels. If count attribute is not specified, then it defaults to the pattern that matches any node with the same node type as the current node and, if the current node has an expanded-name, with the same expanded-name as the current node.
Returns:
Value of "count" attribute.

setFrom

public void setFrom(XPath v)
Set the "from" attribute. Specifies where to count from. For level="single" or level="multiple": Only ancestors that are searched are those that are descendants of the nearest ancestor that matches the from pattern. For level="any: Only nodes after the first node before the current node that match the from pattern are considered.
Parameters:
v - Value to set for "from" attribute.

getFrom

public XPath getFrom()
Get the "from" attribute. For level="single" or level="multiple": Only ancestors that are searched are those that are descendants of the nearest ancestor that matches the from pattern. For level="any: Only nodes after the first node before the current node that match the from pattern are considered.
Returns:
Value of "from" attribute.

setLevel

public void setLevel(int v)
Set the "level" attribute. The level attribute specifies what levels of the source tree should be considered; it has the values single, multiple or any. The default is single.
Parameters:
v - Value to set for "level" attribute.

getLevel

public int getLevel()
Get the "level" attribute. The level attribute specifies what levels of the source tree should be considered; it has the values single, multiple or any. The default is single.
Returns:
Value of "level" attribute.

setValue

public void setValue(XPath v)
Set the "value" attribute. The value attribute contains an expression. The expression is evaluated and the resulting object is converted to a number as if by a call to the number function.
Parameters:
v - Value to set for "value" attribute.

getValue

public XPath getValue()
Get the "value" attribute. The value attribute contains an expression. The expression is evaluated and the resulting object is converted to a number as if by a call to the number function.
Returns:
Value of "value" attribute.

setFormat

public void setFormat(AVT v)
Set the "format" attribute. The "format" attribute is used to control conversion of a list of numbers into a string.
Parameters:
v - Value to set for "format" attribute.
See Also:
convert in XSLT Specification

getFormat

public AVT getFormat()
Get the "format" attribute. The "format" attribute is used to control conversion of a list of numbers into a string.
Returns:
Value of "format" attribute.
See Also:
convert in XSLT Specification

setLang

public void setLang(AVT v)
Set the "lang" attribute. When numbering with an alphabetic sequence, the lang attribute specifies which language's alphabet is to be used; it has the same range of values as xml:lang [XML]; if no lang value is specified, the language should be determined from the system environment. Implementers should document for which languages they support numbering.
Parameters:
v - Value to set for "lang" attribute.
See Also:
convert in XSLT Specification

getLang

public AVT getLang()
Get the "lang" attribute. When numbering with an alphabetic sequence, the lang attribute specifies which language's alphabet is to be used; it has the same range of values as xml:lang [XML]; if no lang value is specified, the language should be determined from the system environment. Implementers should document for which languages they support numbering.
Returns:
Value ofr "lang" attribute.
See Also:
convert in XSLT Specification

setLetterValue

public void setLetterValue(AVT v)
Set the "letter-value" attribute. The letter-value attribute disambiguates between numbering sequences that use letters.
Parameters:
v - Value to set for "letter-value" attribute.
See Also:
convert in XSLT Specification

getLetterValue

public AVT getLetterValue()
Get the "letter-value" attribute. The letter-value attribute disambiguates between numbering sequences that use letters.
Returns:
Value to set for "letter-value" attribute.
See Also:
convert in XSLT Specification

setGroupingSeparator

public void setGroupingSeparator(AVT v)
Set the "grouping-separator" attribute. The grouping-separator attribute gives the separator used as a grouping (e.g. thousands) separator in decimal numbering sequences.
Parameters:
v - Value to set for "grouping-separator" attribute.
See Also:
convert in XSLT Specification

getGroupingSeparator

public AVT getGroupingSeparator()
Get the "grouping-separator" attribute. The grouping-separator attribute gives the separator used as a grouping (e.g. thousands) separator in decimal numbering sequences.
Returns:
Value of "grouping-separator" attribute.
See Also:
convert in XSLT Specification

setGroupingSize

public void setGroupingSize(AVT v)
Set the "grouping-size" attribute. The optional grouping-size specifies the size (normally 3) of the grouping.
Parameters:
v - Value to set for "grouping-size" attribute.
See Also:
convert in XSLT Specification

getGroupingSize

public AVT getGroupingSize()
Get the "grouping-size" attribute. The optional grouping-size specifies the size (normally 3) of the grouping.
Returns:
Value of "grouping-size" attribute.
See Also:
convert in XSLT Specification

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.
Overrides:
compose in class ElemTemplateElement

getXSLToken

public int getXSLToken()
Get an int constant identifying the type of element.
Returns:
The token ID for this element
Overrides:
getXSLToken in class ElemTemplateElement
See Also:
Constants

getNodeName

public java.lang.String getNodeName()
Return the node name.
Returns:
The element's name
Overrides:
getNodeName in class ElemTemplateElement

execute

public void execute(TransformerImpl transformer)
             throws TransformerException
Execute an xsl:number instruction. The xsl:number element is used to insert a formatted number into the result tree.
Parameters:
transformer - non-null reference to the the current transform-time state.
Throws:
TransformerException -  
Overrides:
execute in class ElemTemplateElement

appendChild

public ElemTemplateElement appendChild(ElemTemplateElement newChild)
Add a child to the child list.
Parameters:
newChild - Child to add to child list
Returns:
Child just added to child list
Throws:
DOMException -  
Overrides:
appendChild in class ElemTemplateElement

getPreviousNode

public int getPreviousNode(XPathContext xctxt,
                           int pos)
                    throws TransformerException
Get the previous node to be counted.
Parameters:
xctxt - The XPath runtime state for this.
pos - The current node
Returns:
the previous node to be counted.
Throws:
TransformerException -  

getTargetNode

public int getTargetNode(XPathContext xctxt,
                         int sourceNode)
                  throws TransformerException
Get the target node that will be counted..
Parameters:
xctxt - The XPath runtime state for this.
sourceNode - non-null reference to the current source node.
Returns:
the target node that will be counted
Throws:
TransformerException -  

callChildVisitors

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


Copyright 2006 Apache XML Project. All Rights Reserved.