org.exist.xquery.functions
Class CollatingFunction

java.lang.Object
  org.exist.xquery.AbstractExpression
      org.exist.xquery.PathExpr
          org.exist.xquery.Function
              org.exist.xquery.functions.CollatingFunction

All Implemented Interfaces:

CompiledXQuery, Expression

Direct Known Subclasses:

FunCompare, FunContains, FunEndsWith, FunMax, FunMin, FunStartsWith, FunSubstringAfter, FunSubstringBefore

public abstract class CollatingFunction

extends Function

Base class for functions accepting an optional collation argument.

Author:

wolf

Field Summary

Fields inherited from class org.exist.xquery.Function

BUILTIN_FUNCTION_NS, mySignature

Fields inherited from class org.exist.xquery.PathExpr

inPredicate, keepVirtual, LOG, source, steps

Fields inherited from class org.exist.xquery.AbstractExpression

context, contextDocSet, contextId

Fields inherited from interface org.exist.xquery.Expression

EXPRESSION_ID_INVALID, IGNORE_CONTEXT, IN_PREDICATE, IN_UPDATE, IN_WHERE_CLAUSE, NO_CONTEXT_ID, SINGLE_STEP_EXECUTION

Constructor Summary

CollatingFunction(XQueryContext context, FunctionSignature signature)

Method Summary

protected java.text.Collator

getCollator(Sequence contextSequence, Item contextItem, int arg)

Methods inherited from class org.exist.xquery.Function

analyze, checkArgument, checkArguments, createFunction, dump, eval, getArgument, getArgumentCount, getArguments, getASTNode, getCardinality, getDependencies, getName, getParent, getSignature, isCalledAs, returnsType, setArguments, setASTNode, setParent, setPrimaryAxis, toString

Methods inherited from class org.exist.xquery.PathExpr

add, add, addPath, addPredicate, dump, getContext, getDocumentSet, getExpression, getLastExpression, getLength, getLiteralValue, getSource, isValid, replaceLastExpression, reset, resetState, setContext, setSource

Methods inherited from class org.exist.xquery.AbstractExpression

eval, getContextDocSet, getContextId, getExpressionId, setContextDocSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exist.xquery.CompiledXQuery

eval

Constructor Detail

CollatingFunction

public CollatingFunction(XQueryContext context,
                         FunctionSignature signature)

Parameters:

context -

signature -

Method Detail

getCollator

protected java.text.Collator getCollator(Sequence contextSequence,
                                         Item contextItem,
                                         int arg)
                                  throws XPathException

Throws:

XPathException