org.apache.xalan.templates

Class ElemNumber

public class ElemNumber extends ElemTemplateElement

Implement xsl:number.
 
 
 

See Also: number in XSLT Specification

UNKNOWN: advanced

Method Summary
ElemTemplateElementappendChild(ElemTemplateElement newChild)
Add a child to the child list.
voidcallChildVisitors(XSLTVisitor visitor, boolean callAttrs)
Call the children visitors.
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.
voidexecute(TransformerImpl transformer)
Execute an xsl:number instruction.
XPathgetCount()
Get the "count" attribute.
AVTgetFormat()
Get the "format" attribute.
XPathgetFrom()
Get the "from" attribute.
AVTgetGroupingSeparator()
Get the "grouping-separator" attribute.
AVTgetGroupingSize()
Get the "grouping-size" attribute.
AVTgetLang()
Get the "lang" attribute.
AVTgetLetterValue()
Get the "letter-value" attribute.
intgetLevel()
Get the "level" attribute.
StringgetNodeName()
Return the node name.
intgetPreviousNode(XPathContext xctxt, int pos)
Get the previous node to be counted.
intgetTargetNode(XPathContext xctxt, int sourceNode)
Get the target node that will be counted..
XPathgetValue()
Get the "value" attribute.
intgetXSLToken()
Get an int constant identifying the type of element.
voidsetCount(XPath v)
Set the "count" attribute.
voidsetFormat(AVT v)
Set the "format" attribute.
voidsetFrom(XPath v)
Set the "from" attribute.
voidsetGroupingSeparator(AVT v)
Set the "grouping-separator" attribute.
voidsetGroupingSize(AVT v)
Set the "grouping-size" attribute.
voidsetLang(AVT v)
Set the "lang" attribute.
voidsetLetterValue(AVT v)
Set the "letter-value" attribute.
voidsetLevel(int v)
Set the "level" attribute.
voidsetValue(XPath v)
Set the "value" attribute.

Method Detail

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

callChildVisitors

public void callChildVisitors(XSLTVisitor visitor, boolean callAttrs)
Call the children visitors.

Parameters: visitor The visitor whose appropriate method will be called.

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.

execute

public void execute(TransformerImpl transformer)
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

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.

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

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.

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

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

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

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

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.

getNodeName

public String getNodeName()
Return the node name.

Returns: The element's name

getPreviousNode

public int getPreviousNode(XPathContext xctxt, int pos)
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)
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

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.

getXSLToken

public int getXSLToken()
Get an int constant identifying the type of element.

Returns: The token ID for this element

See Also:

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.

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

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.

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

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

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

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

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.

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.

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