net.sf.saxon.functions
Class CollatingFunction

java.lang.Object
  net.sf.saxon.expr.Expression
      net.sf.saxon.expr.FunctionCall
          net.sf.saxon.functions.SystemFunction
              net.sf.saxon.functions.CollatingFunction

All Implemented Interfaces:

Serializable, SourceLocator, EvaluableItem, SequenceIterable, InstructionInfoProvider

Direct Known Subclasses:

Compare, Contains, DeepEqual, DistinctValues, Index, IndexOf, Minimax

public abstract class CollatingFunction
extends SystemFunction

Abstract superclass for all functions that take an optional collation argument

See Also:

Serialized Form

Field Summary

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

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

CollatingFunction()

Method Summary

void	checkArguments(ExpressionVisitor visitor) Method called during static type checking
Expression	copy() Copy an expression.
URI	getExpressionBaseURI() Get the saved static base URI
StringCollator	getStringCollator() Get the collation if known statically, as a StringCollator object

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

addDocToPathMap, computeCardinality, computeSpecialProperties, getDetails, getErrorCodeForTypeErrors, getItemType, makeSystemFunction, optimize, setDetails

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

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

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

addToPathMap, adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, display, doPromotion, effectiveBooleanValue, evaluateAsString, evaluateItem, explain, findParentOf, getCardinality, getColumnNumber, getContainer, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, iterate, iterateEvents, markTailFunctionCalls, process, setContainer, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CollatingFunction

public CollatingFunction()

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 SystemFunction

Parameters:

visitor - the expression visitor

Throws:

XPathException

getExpressionBaseURI

public URI getExpressionBaseURI()

Get the saved static base URI

Returns:

the static base URI

getStringCollator

public StringCollator getStringCollator()

Get the collation if known statically, as a StringCollator object

Returns:

a StringCollator. Return null if the collation is not known statically.

copy

public Expression copy()

Copy an expression. This makes a deep copy.

Overrides:

copy in class SystemFunction

Returns:

the copy of the original expression