net.sf.saxon.expr.accum

Class AccumulatorRegistry

java.lang.Object

net.sf.saxon.expr.accum.AccumulatorRegistry

public class AccumulatorRegistry
extends Object

Static registry for accumulators (XSLT 3.0) defined within a single package. Generally accessed via the PackageData object for the package.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<StructuredQName,Accumulator>	accumulatorsByName

Constructor Summary

Constructors

Constructor and Description
AccumulatorRegistry()

Method Summary

Modifier and Type	Method and Description
void	addAccumulator(Accumulator acc) Register an accumulator
Accumulator	getAccumulator(StructuredQName name) Get the accumulator with a given name
Iterable<Accumulator>	getAllAccumulators() Get all the registered accumulators
Sequence<?>	getStreamingAccumulatorValue(NodeInfo node, Accumulator accumulator, AccumulatorFn.Phase phase) Get the run-time value of a streamed accumulator
Set<Accumulator>	getUsedAccumulators(String useAccumulatorsAtt, StyleElement styleElement) Process the use-accumulators attribute of instructions such as xsl:stream, xsl:mode, etc

Methods inherited from class java.lang.Object

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

Field Detail

accumulatorsByName

protected Map<StructuredQName,Accumulator> accumulatorsByName

Constructor Detail

AccumulatorRegistry

public AccumulatorRegistry()

Method Detail

getUsedAccumulators

public Set<Accumulator> getUsedAccumulators(String useAccumulatorsAtt,
                                            StyleElement styleElement)
                                     throws XPathException

Process the use-accumulators attribute of instructions such as xsl:stream, xsl:mode, etc

Parameters:

useAccumulatorsAtt - the value of the use-accumulators attribute

Returns:

the list of accumulators referenced

Throws:

XPathException - if the attribute is invalid

addAccumulator

public void addAccumulator(Accumulator acc)

Register an accumulator

Parameters:

acc - the accumulator to be registered

getAccumulator

public Accumulator getAccumulator(StructuredQName name)

Get the accumulator with a given name

Parameters:

name - the name of the accumulator

Returns:

the accumulator with this name

getAllAccumulators

public Iterable<Accumulator> getAllAccumulators()

Get all the registered accumulators

Returns:

a collection of accumulators

getStreamingAccumulatorValue

public Sequence<?> getStreamingAccumulatorValue(NodeInfo node,
                                                Accumulator accumulator,
                                                AccumulatorFn.Phase phase)
                                         throws XPathException

Get the run-time value of a streamed accumulator

Parameters:

node - the context node, which must be a streamed node

accumulator - the accumulator whose value is required

phase - pre-descent or post-descent

Returns:

the value of the accumulator, or null if the context node is not streamed

Throws:

XPathException - if a dynamic error occurs