Package org.basex.query.func.fn

Class FnSort

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.Arr

org.basex.query.func.StandardFunc

org.basex.query.func.fn.FnSort

public final class FnSort
extends StandardFunc

Function implementation.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.query.func.StandardFunc

definition, sc

Fields inherited from class org.basex.query.expr.Arr

exprs

Fields inherited from class org.basex.query.expr.ParseExpr

exprType, info

Constructor Summary

Constructors

Constructor	Description
FnSort()

Method Summary

Modifier and Type	Method	Description
boolean	has(Flag... flags)	Indicates if an expression has one of the specified compiler properties.
Iter	iter(QueryContext qc)	Evaluates the expression and returns an iterator on the resulting items.
protected Expr	opt(CompileContext cc)	Performs function specific optimizations.
Expr	simplifyFor(CompileContext.Simplify mode, CompileContext cc)	This function is called at compile time for expressions whose operands might be simplified.
static Integer[]	sort(ValueList values, StandardFunc sf, Collation coll, QueryContext qc)	Sort the input data and returns integers representing the item order.
Value	value(QueryContext qc)	Evaluates the expression and returns the resulting value.

Methods inherited from class org.basex.query.func.StandardFunc

checkAdmin, checkArity, checkArity, checkCreate, checkData, checkPath, checkPath, coerceFunc, compileData, copy, data, data, dataLock, dateTimeToMs, description, equals, optFirst, optFirst, optimize, plan, plan, serialize, simplifyArgs, toBaseUri, toBindings, toCollation, toDate, toDBNode, toEncodingOrNull, toNodeOrAtomItem, toOptions, toPath, toPath, toQuery, toQuery, vacuous

Methods inherited from class org.basex.query.expr.Arr

accept, allAreValues, args, checkUp, compile, copyAll, count, exprSize, flatten, inline, inline, inlineable, mayBePositional, simplifyAll

Methods inherited from class org.basex.query.expr.ParseExpr

adoptType, atomValue, checkAllUp, checkNoEmpty, checkNoEmpty, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, ebv, item, refineType, seqType, size, test, toArray, toArray, toAtomItem, toB64, toB64, toBin, toBin, toBoolean, toBoolean, toBytes, toBytes, toDouble, toDouble, toElem, toFloat, toFunc, toItem, toItem, toLong, toLong, toMap, toMap, toNode, toNode, toNodeOrNull, toNumber, toNumberOrNull, toQNm, toQNm, toToken, toToken, toTokenOrNull, toZeroToken

Methods inherited from class org.basex.query.expr.Expr

arg, atomItem, atomIter, ddo, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, typeCheck, uses, visitAll

Methods inherited from class org.basex.query.expr.ExprInfo

toErrorString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

FnSort

public FnSort()

Method Details

iter

public Iter iter(QueryContext qc)
          throws QueryException

Description copied from class: Expr

Evaluates the expression and returns an iterator on the resulting items. The implementation of this method is optional.

Overrides:

iter in class ParseExpr

Parameters:

qc - query context

Returns:

iterator

Throws:

QueryException - query exception

value

public Value value(QueryContext qc)
            throws QueryException

Description copied from class: Expr

Evaluates the expression and returns the resulting value. If this method is not implemented, Expr.item(QueryContext, InputInfo) must be implemented instead.

Overrides:

value in class ParseExpr

Parameters:

qc - query context

Returns:

value

Throws:

QueryException - query exception

sort

public static Integer[] sort(ValueList values,
 StandardFunc sf,
 Collation coll,
 QueryContext qc)
                      throws QueryException

Sort the input data and returns integers representing the item order.

Parameters:

values - value list

sf - calling function

coll - collation

qc - query context

Returns:

item order

Throws:

QueryException - query exception

opt

protected Expr opt(CompileContext cc)
            throws QueryException

Description copied from class: StandardFunc

Performs function specific optimizations.

Overrides:

opt in class StandardFunc

Parameters:

cc - compilation context

Returns:

optimized or original expression

Throws:

QueryException - query exception

simplifyFor

public Expr simplifyFor(CompileContext.Simplify mode,
 CompileContext cc)
                 throws QueryException

Description copied from class: Expr

This function is called at compile time for expressions whose operands might be simplified.

Overrides:

simplifyFor in class Expr

Parameters:

mode - mode of simplification

cc - compilation context

Returns:

simplified or original expression

Throws:

QueryException - query exception

See Also:

• CompileContext.Simplify

has

public boolean has(Flag... flags)

Description copied from class: Expr

Indicates if an expression has one of the specified compiler properties. This method must only be called at compile time. It is invoked to test properties of sub-expressions. It returns true if at least flag matches an expression.

Overrides:

has in class StandardFunc

Parameters:

flags - flags to be checked

Returns:

result of check