com.saxonica.xslt3.instruct

Class Accumulator

java.lang.Object

net.sf.saxon.expr.instruct.ComponentBody

com.saxonica.xslt3.instruct.Accumulator

All Implemented Interfaces:

SourceLocator, Container, InstructionInfo

public class Accumulator
extends ComponentBody

Represents a single accumulator declared in an XSLT 3.0 stylesheet

Field Summary

Fields inherited from class net.sf.saxon.expr.instruct.ComponentBody

body

Constructor Summary

Constructors

Constructor and Description
Accumulator()

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildExpression(Expression expression) Add an expression to the list of expressions used by this accumulator
StructuredQName	getAccumulatorName() Get the name of the accumulator
Pattern	getAppliesTo() Get the pattern which determins which documents this accumulator applies to
int	getComponentKind() Get the kind of component that this represents, using integer constants such as StandardNames.XSL_FUNCTION
int	getConstructType() Get the type of construct.
int	getImportPrecedence() Get the import precedence
Expression	getInitialValueExpression() Get the expression that computes the initial value of the accumulator
StructuredQName	getObjectName() Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
Mode	getPostDescentRules() Get the set of rules for phase="end", held in the form of a Mode object
Mode	getPreDescentRules() Get the set of rules for phase="start", held in the form of a Mode object
SlotManager	getSlotManagerForInitialValueExpression() Get the slotManager to be used for evaluating the initial-value expression
SequenceType	getType() Get the declared type of the accumulator.
boolean	isCompatible(Accumulator other) Determine whether this accumulator is compatible with one that it overrides
boolean	isDeclaredStreamable() Ask whether the accumulator is declared streamable
void	setAccumulatorName(StructuredQName firstName) Set the name of the pre-descent function
void	setAppliesTo(Pattern pattern) Set the pattern which determines which documents this accumulator applies to
void	setDeclaredStreamable(boolean streamable) Say whether the accumulator is declared streamable
void	setImportPrecedence(int importPrecedence) Set the import precedence
void	setInitialValueExpression(Expression initialValueExpression) Set the expression that computes the initial value of the accumulator
void	setPostDescentRules(Mode postDescentRules) Set the set of rules for phase="end", held in the form of a Mode object
void	setPreDescentRules(Mode preDescentRules) Set the set of rules for phase="start", held in the form of a Mode object
void	setSlotManagerForInitialValueExpression(SlotManager slotManagerForInitialValueExpression) Set the slotManager to be used for evaluating the initial-value expression
void	setType(SequenceType type) Set the declared type of the accumulator.

Methods inherited from class net.sf.saxon.expr.instruct.ComponentBody

allocateAllBindingSlots, allocateBindingSlotsRecursive, getBody, getColumnNumber, getConfiguration, getContainerGranularity, getDeclaringComponent, getHostLanguage, getLineNumber, getLocationProvider, getPackageData, getProperties, getProperty, getPublicId, getStackFrameMap, getSystemId, makeDeclaringComponent, setBody, setHostLanguage, setLineNumber, setPackageData, setStackFrameMap, setSystemId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Accumulator

public Accumulator()

Method Detail

isDeclaredStreamable

public boolean isDeclaredStreamable()

Ask whether the accumulator is declared streamable

Returns:

true if it is declared with streamable="yes"

setDeclaredStreamable

public void setDeclaredStreamable(boolean streamable)

Say whether the accumulator is declared streamable

Parameters:

streamable - true if it is declared with streamable="yes"

getAccumulatorName

public StructuredQName getAccumulatorName()

Get the name of the accumulator

Returns:

the accumulator name

setAccumulatorName

public void setAccumulatorName(StructuredQName firstName)

Set the name of the pre-descent function

Parameters:

firstName - the function name (always present)

getImportPrecedence

public int getImportPrecedence()

Get the import precedence

Returns:

the import precedence of the accumulator

setImportPrecedence

public void setImportPrecedence(int importPrecedence)

Set the import precedence

Parameters:

importPrecedence - the import precedence of the accumulator

getSlotManagerForInitialValueExpression

public SlotManager getSlotManagerForInitialValueExpression()

Get the slotManager to be used for evaluating the initial-value expression

Returns:

the slotManager for the initial-value expression (defining any local variables declared and used within this expression)

setSlotManagerForInitialValueExpression

public void setSlotManagerForInitialValueExpression(SlotManager slotManagerForInitialValueExpression)

Set the slotManager to be used for evaluating the initial-value expression

Parameters:

slotManagerForInitialValueExpression - the slotManager for the initial-value expression (defining any local variables declared and used within this expression)

getPreDescentRules

public Mode getPreDescentRules()

Get the set of rules for phase="start", held in the form of a Mode object

Returns:

the Mode object containing all the rules that apply to phase="start"

setPreDescentRules

public void setPreDescentRules(Mode preDescentRules)

Set the set of rules for phase="start", held in the form of a Mode object

Parameters:

preDescentRules - the Mode object containing all the rules that apply to phase="start"

getPostDescentRules

public Mode getPostDescentRules()

Get the set of rules for phase="end", held in the form of a Mode object

Returns:

the Mode object containing all the rules that apply to phase="end"

setPostDescentRules

public void setPostDescentRules(Mode postDescentRules)

Set the set of rules for phase="end", held in the form of a Mode object

Parameters:

postDescentRules - the Mode object containing all the rules that apply to phase="end"

getInitialValueExpression

public Expression getInitialValueExpression()

Get the expression that computes the initial value of the accumulator

Returns:

the initial value expression

setInitialValueExpression

public void setInitialValueExpression(Expression initialValueExpression)

Set the expression that computes the initial value of the accumulator

Parameters:

initialValueExpression - the initial value expression

addChildExpression

public void addChildExpression(Expression expression)

Add an expression to the list of expressions used by this accumulator

Parameters:

expression - the expression to be added to the list

getType

public SequenceType getType()

Get the declared type of the accumulator. The initial value and all intermediate values must conform to this type

Returns:

the declared type of the accumulator

setType

public void setType(SequenceType type)

Set the declared type of the accumulator. The initial value and all intermediate values must conform to this type

Parameters:

type - the declared type of the accumulator

setAppliesTo

public void setAppliesTo(Pattern pattern)

Set the pattern which determines which documents this accumulator applies to

Parameters:

pattern - the pattern

getAppliesTo

public Pattern getAppliesTo()

Get the pattern which determins which documents this accumulator applies to

Returns:

the pattern; if none has been explicitly specified, a pattern equivalent to "*" is returned.

isCompatible

public boolean isCompatible(Accumulator other)

Determine whether this accumulator is compatible with one that it overrides

Parameters:

other - the accumlator that this one overrides

Returns:

true if they are compatible, as defined in the XSLT 3.0 specification

getComponentKind

public int getComponentKind()

Get the kind of component that this represents, using integer constants such as StandardNames.XSL_FUNCTION

Specified by:

getComponentKind in class ComponentBody

getConstructType

public int getConstructType()

Get the type of construct. This will either be the fingerprint of a standard XSLT instruction name (values in StandardNames: all less than 1024) or it will be a constant in class Location.

Returns:

an integer identifying the kind of construct

getObjectName

public StructuredQName getObjectName()

Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc. This is used only where the name is known statically.

Returns:

the QName of the object declared or manipulated by this instruction or expression