net.sf.saxon.functions

Class DistinctValues

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.CollatingFunction

net.sf.saxon.functions.DistinctValues

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, EvaluableItem, SequenceIterable, InstructionInfo, org.xml.sax.Locator

public class DistinctValues
extends CollatingFunction

The XPath 2.0 distinct-values() function

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistinctValues.DistinctIterator Iterator class to return the distinct values in a sequence

Field Summary

Fields inherited from class net.sf.saxon.functions.CollatingFunction

stringCollator

Fields inherited from class net.sf.saxon.functions.SystemFunction

operation

Fields inherited from class net.sf.saxon.expr.FunctionCall

argument

Fields inherited from class net.sf.saxon.expr.Expression

EVALUATE_METHOD, EVENT_FEED_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, PROCESS_METHOD, PUSH_SELECTION, staticProperties, WATCH_METHOD

Constructor Summary

Constructors

Constructor and Description
DistinctValues()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkArguments(ExpressionVisitor visitor) Method called during static type checking
AtomicComparer	getAtomicComparer() Get the AtomicComparer allocated at compile time.
SequenceIterator	iterate(XPathContext context) Evaluate the function to return an iteration of selected values or nodes.
AtomicComparer	makeAtomicComparer(XPathContext context) Get the AtomicComparer, creating it if it was not allocated at compile time.

Methods inherited from class net.sf.saxon.functions.CollatingFunction

copy, getAbsoluteCollationURI, getAtomicComparer, getCollator, getExpressionBaseURI, getStringCollator

Methods inherited from class net.sf.saxon.functions.SystemFunction

addContextDocumentArgument, addDocToPathMap, computeCardinality, computeSpecialProperties, getDetails, getErrorCodeForTypeErrors, getImplementationMethod, getItemType, getRequiredType, makeSystemFunction, optimize, setDetails, useContextItemAsDefault

Methods inherited from class net.sf.saxon.expr.FunctionCall

addExternalFunctionCallToPathMap, checkArgumentCount, equals, explain, getArguments, getDisplayName, getExpressionName, getFunctionName, getNumberOfArguments, hashCode, iterateSubExpressions, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionName, simplify, simplifyArguments, toString, typeCheck

Methods inherited from class net.sf.saxon.expr.Expression

addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getColumnNumber, getConstructType, getContainer, getDependencies, getEvaluationMethod, getExecutable, getHostLanguage, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterateEvents, iterateSameFocusSubExpressions, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, typeError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DistinctValues

public DistinctValues()

Method Detail

checkArguments

public void checkArguments(ExpressionVisitor visitor)
                    throws XPathException

Description copied from class: SystemFunction

Method called during static type checking

Overrides:

checkArguments in class CollatingFunction

Parameters:

visitor - the expression visitor

Throws:

XPathException

getAtomicComparer

public AtomicComparer getAtomicComparer()

Get the AtomicComparer allocated at compile time.

Returns:

the AtomicComparer if one has been allocated at compile time; return null if the collation is not known until run-time

makeAtomicComparer

public AtomicComparer makeAtomicComparer(XPathContext context)
                                  throws XPathException

Get the AtomicComparer, creating it if it was not allocated at compile time.

Returns:

the AtomicComparer already allocated if one has been allocated at compile time; otherwise allocate one from knowledge of the collation at run-time

Throws:

XPathException

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Evaluate the function to return an iteration of selected values or nodes.

Specified by:

iterate in interface SequenceIterable

Overrides:

iterate in class Expression

Parameters:

context - supplies the context for evaluation

Returns:

a SequenceIterator that can be used to iterate over the result of the expression

Throws:

XPathException - if any dynamic error occurs evaluating the expression