Package net.sf.saxon.functions
Class CollatingFunction
java.lang.Object
net.sf.saxon.expr.ComputedExpression
net.sf.saxon.expr.FunctionCall
net.sf.saxon.functions.SystemFunction
net.sf.saxon.functions.CollatingFunction
- All Implemented Interfaces:
Serializable
,SourceLocator
,Container
,Expression
,InstructionInfoProvider
Abstract superclass for all functions that take an optional collation argument
- See Also:
-
Field Summary
FieldsFields 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.ComputedExpression
locationId, staticProperties
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Method called during static type checkingprotected GenericAtomicComparer
getAtomicComparer
(int arg, XPathContext context) Get a GenericAtomicComparer that can be used to compare valuesprotected Comparator
getCollator
(int arg, XPathContext context) Get a collator suitable for comparing strings.Methods inherited from class net.sf.saxon.functions.SystemFunction
addContextDocumentArgument, computeCardinality, computeSpecialProperties, display, getDetails, getErrorCodeForTypeErrors, getItemType, getRequiredType, main, makeSystemFunction, setDetails, useContextItemAsDefault
Methods inherited from class net.sf.saxon.expr.FunctionCall
checkArgumentCount, getArguments, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, optimize, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionNameCode, simplify, simplifyArguments, typeCheck
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, iterate, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError
-
Field Details
-
collation
-
-
Constructor Details
-
CollatingFunction
public CollatingFunction()
-
-
Method Details
-
checkArguments
Description copied from class:SystemFunction
Method called during static type checking- Overrides:
checkArguments
in classSystemFunction
- Throws:
XPathException
-
getAtomicComparer
protected GenericAtomicComparer getAtomicComparer(int arg, XPathContext context) throws XPathException Get a GenericAtomicComparer that can be used to compare values- Parameters:
arg
- the position of the argument (starting at 0) containing the collation name. If this argument was not supplied, the default collation is usedcontext
- The dynamic evaluation context.- Throws:
XPathException
-
getCollator
Get a collator suitable for comparing strings. Returns the collator specified in the given function argument if present, otherwise returns the default collator.- Parameters:
arg
- The argument position (counting from zero) that holds the collation URI if presentcontext
- The dynamic context- Returns:
- a Comparator, which will either be a java.text.Collator, or a CodepointCollator
- Throws:
XPathException
-