org.exist.xquery.functions.system
Class CountInstances

java.lang.Object
  org.exist.xquery.AbstractExpression
      org.exist.xquery.PathExpr
          org.exist.xquery.Function
              org.exist.xquery.BasicFunction
                  org.exist.xquery.functions.system.CountInstances

All Implemented Interfaces:

CompiledXQuery, Expression, CompiledExpression

public class CountInstances
extends BasicFunction

Return details about eXist instances

Author:

Adam Retter (adam.retter@devon.gov.uk)

Field Summary

static FunctionSignature	countInstancesActive
static FunctionSignature	countInstancesAvailable
static FunctionSignature	countInstancesMax

Fields inherited from class org.exist.xquery.Function

BUILTIN_FUNCTION_NS

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, POSITIONAL_PREDICATE, SINGLE_STEP_EXECUTION, USE_TREE_TRAVERSAL

Constructor Summary

CountInstances(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, createFunction, dump, getArgument, getArgumentCount, getArguments, getCardinality, getDependencies, getName, getParent, getSignature, isCalledAs, returnsType, setArguments, setParent, setPrimaryAxis, toString

Methods inherited from class org.exist.xquery.PathExpr

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

Methods inherited from class org.exist.xquery.AbstractExpression

eval, getContextDocSet, getContextId, getExpressionId, getSource, setASTNode, setContextDocSet, setLocation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.exist.xquery.CompiledXQuery

eval, getSource

Field Detail

countInstancesMax

public static final FunctionSignature countInstancesMax

countInstancesActive

public static final FunctionSignature countInstancesActive

countInstancesAvailable

public static final FunctionSignature countInstancesAvailable

Constructor Detail

CountInstances

public CountInstances(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