org.exist.xquery.functions.xmldb
Class XMLDBAbstractCollectionManipulator

java.lang.Object
  org.exist.xquery.AbstractExpression
      org.exist.xquery.PathExpr
          org.exist.xquery.Function
              org.exist.xquery.BasicFunction
                  org.exist.xquery.functions.xmldb.XMLDBAbstractCollectionManipulator

All Implemented Interfaces:

CompiledXQuery, Expression

Direct Known Subclasses:

XMLDBChmodCollection, XMLDBChmodResource, XMLDBCollectionExists, XMLDBCreateCollection, XMLDBCreated, XMLDBGetChildCollections, XMLDBGetChildResources, XMLDBHasLock, XMLDBLoadFromPattern, XMLDBPermissions, XMLDBRemove, XMLDBSetCollectionPermissions, XMLDBSetResourcePermissions, XMLDBSize, XMLDBStore

public abstract class XMLDBAbstractCollectionManipulator

extends BasicFunction

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

XMLDBAbstractCollectionManipulator(XQueryContext context, FunctionSignature signature)

XMLDBAbstractCollectionManipulator(XQueryContext context, FunctionSignature signature, boolean errorIfAbsent)

Method Summary

protected LocalCollection	createLocalCollection(java.lang.String name)
Sequence	eval(Sequence[] args, Sequence contextSequence) Process the function.
protected abstract Sequence	evalWithCollection(Collection c, Sequence[] args, Sequence contextSequence)

Methods inherited from class org.exist.xquery.BasicFunction

eval

Methods inherited from class org.exist.xquery.Function

analyze, checkArgument, checkArguments, createFunction, dump, 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

XMLDBAbstractCollectionManipulator

public XMLDBAbstractCollectionManipulator(XQueryContext context,
                                          FunctionSignature signature)

XMLDBAbstractCollectionManipulator

public XMLDBAbstractCollectionManipulator(XQueryContext context,
                                          FunctionSignature signature,
                                          boolean errorIfAbsent)

Method Detail

createLocalCollection

protected LocalCollection createLocalCollection(java.lang.String name)
                                         throws XMLDBException

Throws:

XMLDBException

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

Parameters:

args -

contextSequence -

Returns:

Throws:

XPathException

evalWithCollection

protected abstract Sequence evalWithCollection(Collection c,
                                               Sequence[] args,
                                               Sequence contextSequence)
                                        throws XPathException

Throws:

XPathException