net.sf.saxon.instruct
Class NumberInstruction

java.lang.Object
  |
  +--net.sf.saxon.instruct.Instruction
        |
        +--net.sf.saxon.instruct.NumberInstruction
All Implemented Interfaces:
Instr, Locatable, java.io.Serializable, javax.xml.transform.SourceLocator

public class NumberInstruction
extends Instruction

An xsl:number element in the stylesheet.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.instruct.Instruction
children
 
Constructor Summary
NumberInstruction(Expression select, int level, Pattern count, Pattern from, Expression value, Expression format, Expression groupSize, Expression groupSeparator, Expression letterValue, Expression ordinal, Expression lang, NumberFormatter formatter, Numberer numberer, boolean hasVariablesInPatterns)
           
 
Method Summary
 int getCardinality()
          Get the cardinality of the sequence returned by evaluating this instruction
 java.lang.String getInstructionName()
          Get the name of this instruction for diagnostic and tracing purposes
 ItemType getItemType()
          Get the item type of the items returned by evaluating this instruction
static Numberer makeNumberer(java.lang.String language)
          Load a Numberer class for a given language and check it is OK.
 TailCall processLeavingTail(XPathContext context)
          ProcessLeavingTail: called to do the real work of this instruction.
 
Methods inherited from class net.sf.saxon.instruct.Instruction
assembleParams, assembleTunnelParams, displayChildren, dynamicError, dynamicError, getChildren, getColumnNumber, getExecutable, getInstructionNamespace, getLineNumber, getPublicId, getSourceLocator, getSystemId, process, processChildren, processChildrenLeavingTail, recoverableError, setChildren, setExecutable, setSourceLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NumberInstruction

public NumberInstruction(Expression select,
                         int level,
                         Pattern count,
                         Pattern from,
                         Expression value,
                         Expression format,
                         Expression groupSize,
                         Expression groupSeparator,
                         Expression letterValue,
                         Expression ordinal,
                         Expression lang,
                         NumberFormatter formatter,
                         Numberer numberer,
                         boolean hasVariablesInPatterns)
Method Detail

getInstructionName

public java.lang.String getInstructionName()
Get the name of this instruction for diagnostic and tracing purposes

Specified by:
getInstructionName in class Instruction

getItemType

public ItemType getItemType()
Description copied from class: Instruction
Get the item type of the items returned by evaluating this instruction

Overrides:
getItemType in class Instruction
Returns:
the static item type of the instruction

getCardinality

public int getCardinality()
Description copied from class: Instruction
Get the cardinality of the sequence returned by evaluating this instruction

Overrides:
getCardinality in class Instruction
Returns:
the static cardinality

processLeavingTail

public TailCall processLeavingTail(XPathContext context)
                            throws javax.xml.transform.TransformerException
Description copied from class: Instruction
ProcessLeavingTail: called to do the real work of this instruction. This method must be implemented in each subclass. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.

Specified by:
processLeavingTail in interface Instr
Specified by:
processLeavingTail in class Instruction
Parameters:
context - The dynamic context of the transformation, giving access to the current node, the current variables, etc.
Returns:
null if the instruction has completed execution; or a TailCall indicating a function call or template call that is delegated to the caller, to be made after the stack has been unwound so as to save stack space.
javax.xml.transform.TransformerException

makeNumberer

public static Numberer makeNumberer(java.lang.String language)
Load a Numberer class for a given language and check it is OK.

Parameters:
language - the language for which a Numberer is required
Returns:
a suitable numberer. If no specific numberer is available for the language, the default (English) numberer is used.