org.exist.xquery.functions.util
Class IndexKeyDocuments

java.lang.Object
  org.exist.xquery.AbstractExpression
      org.exist.xquery.PathExpr
          org.exist.xquery.Function
              org.exist.xquery.BasicFunction
                  org.exist.xquery.functions.util.IndexKeyDocuments

All Implemented Interfaces:

CompiledXQuery, Expression, RewritableExpression, org.xmldb.api.base.CompiledExpression

public class IndexKeyDocuments
extends BasicFunction

Field Summary

protected static FunctionParameterSequenceType	indexParam
protected static org.apache.log4j.Logger	logger
protected static FunctionParameterSequenceType	nodeParam
protected static FunctionReturnSequenceType	result
static FunctionSignature[]	signatures
protected static FunctionParameterSequenceType	valueParam

Fields inherited from class org.exist.xquery.Function

BUILTIN_FUNCTION_NS, mySignature

Fields inherited from class org.exist.xquery.PathExpr

inPredicate, keepVirtual, LOG, staticContext, steps

Fields inherited from class org.exist.xquery.AbstractExpression

column, context, contextDocSet, contextId, line, unordered

Fields inherited from interface org.exist.xquery.Expression

DOT_TEST, EXPRESSION_ID_INVALID, IGNORE_CONTEXT, IN_NODE_CONSTRUCTOR, IN_PREDICATE, IN_UPDATE, IN_WHERE_CLAUSE, NEED_INDEX_INFO, NO_CONTEXT_ID, NON_STREAMABLE, POSITIONAL_PREDICATE, SINGLE_STEP_EXECUTION, UNORDERED, USE_TREE_TRAVERSAL

Constructor Summary

IndexKeyDocuments(XQueryContext context, FunctionSignature signature)

Method Summary

Sequence

eval(Sequence[] args, Sequence contextSequence) Process the function.

Methods inherited from class org.exist.xquery.BasicFunction

eval

Methods inherited from class org.exist.xquery.Function

accept, analyze, checkArgument, checkArguments, createFunction, dump, getArgument, getArgumentCount, getArguments, getCardinality, getDependencies, getName, getParent, getParentModule, getSignature, isCalledAs, returnsType, setArguments, setParent, setPrimaryAxis, simplify, toString

Methods inherited from class org.exist.xquery.PathExpr

add, add, addPath, addPredicate, allowMixNodesInReturn, dump, getColumn, getContext, getDocumentSet, getExpression, getLastExpression, getLength, getLine, getLiteralValue, getPrimaryAxis, getSubExpression, getSubExpressionCount, isValid, replaceExpression, replaceLastExpression, reset, resetState, setContext, setUseStaticContext

Methods inherited from class org.exist.xquery.AbstractExpression

eval, getContextDocSet, getContextId, getExpressionId, getSource, match, needsReset, setASTNode, setContextDocSet, setContextId, setLocation

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, getSource

Field Detail

logger

protected static final org.apache.log4j.Logger logger

nodeParam

protected static final FunctionParameterSequenceType nodeParam

valueParam

protected static final FunctionParameterSequenceType valueParam

indexParam

protected static final FunctionParameterSequenceType indexParam

result

protected static final FunctionReturnSequenceType result

signatures

public static final FunctionSignature[] signatures

Constructor Detail

IndexKeyDocuments

public IndexKeyDocuments(XQueryContext context,
                         FunctionSignature signature)

Method Detail

eval

public Sequence eval(Sequence[] args,
                     Sequence contextSequence)
              throws XPathException

Description copied from class: BasicFunction

Process the function. All arguments are passed in the array args. The number of arguments, their type and cardinality have already been checked to match the function signature.

Specified by:

eval in class BasicFunction

Throws:

XPathException