org.exist.xquery
Class BasicFunction

java.lang.Object
  org.exist.xquery.AbstractExpression
      org.exist.xquery.PathExpr
          org.exist.xquery.Function
              org.exist.xquery.BasicFunction

All Implemented Interfaces:

CompiledXQuery, Expression, CompiledExpression

Direct Known Subclasses:

BaseConverter, BinaryDoc, BinaryToString, BuiltinFunctions, Clear, Collations, CollectionName, Compile, CountInstances, Create, DeepCopyFunction, DocumentNameOrId, EncodeURL, Eval, Expand, ExtractDocs, FileRead, FilterNested, FunAdjustTimezone, FunBaseURI, FunCodepointEqual, FunCodepointsToString, FunctionAvailable, FunctionFunction, FunctionTrace, FunDateTime, FunDefaultCollation, FunError, FunEscapeURI, FunGetDateComponent, FunGetDurationComponent, FunIndexOf, FunInScopePrefixes, FunNamespaceURIForPrefix, FunNilled, FunQName, FunResolveQName, FunStringJoin, FunStringToCodepoints, FunTrace, FunTrueOrFalse, FunUnEscapeURI, FuzzyIndexTerms, GetAttributeNames, GetBuild, GetContextPath, GetCookieNames, GetCookieValue, GetData, GetExistHome, GetExists, GetExists, GetExists, GetFragmentBetween, GetHeader, GetHeaderNames, GetHostname, GetIndexStatistics, GetMemory, GetMethod, GetModuleLoadPath, GetNodeById, GetParameter, GetParameterNames, GetPathInfo, GetQueryString, GetRemoteAddr, GetRemoteHost, GetRemotePort, GetRequestAttribute, GetRevision, GetRunningJobs, GetRunningXQueries, GetScheduledJobs, GetSequenceType, GetServerName, GetServerPort, GetUploadedFile, GetUploadedFileName, GetUploadedFileSize, GetUptime, GetURI, GetURL, GetVersion, GrammarTooling, Hash, HighlightMatches, IndexKeyDocuments, IndexKeyOccurrences, IndexKeys, IndexTerms, IndexType, Invalidate, Jaxp, Jaxv, Jing, KillRunningXQuery, KWICDisplay, ListBackups, LogFunction, MatchCount, MD5, ModuleInfo, NodeId, Parse, Profile, PrologFunctions, QNameFunctions, RandomFunction, RedirectTo, RegexpFilter, Restore, RetrieveBackup, Serialize, SetCurrentUser, Shutdown, StreamBinary, SystemProperty, TextRank, Tokenize, Transform, TriggerSystemTask, UpdateStatistics, UUID, Validation, Wait, XMLDBAbstractCollectionManipulator, XMLDBAuthenticate, XMLDBChangeUser, XMLDBCreateUser, XMLDBDefragment, XMLDBDeleteUser, XMLDBGetCurrentUser, XMLDBGetMimeType, XMLDBIsAdmin, XMLDBPermissionsToString, XMLDBRegisterDatabase, XMLDBReindex, XMLDBURIFunctions, XMLDBUserAccess

public abstract class BasicFunction
extends Function

Abstract base class for simple functions. Subclasses should overwrite method eval(Sequence[], Sequence).

Author:

Wolfgang Meier (wolfgang@exist-db.org)

Field Summary

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

BasicFunction(XQueryContext context, FunctionSignature signature)

Method Summary

abstract Sequence	eval(Sequence[] args, Sequence contextSequence) Process the function.
Sequence	eval(Sequence contextSequence, Item contextItem) Evaluate the expression represented by this object.

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

Constructor Detail

BasicFunction

public BasicFunction(XQueryContext context,
                     FunctionSignature signature)

Method Detail

eval

public Sequence eval(Sequence contextSequence,
                     Item contextItem)
              throws XPathException

Description copied from interface: Expression

Evaluate the expression represented by this object. Depending on the context in which this expression is executed, either the context sequence, the context item or both of them may be set. An implementing class should know how to handle this. The general contract is as follows: if the Dependency.CONTEXT_ITEM bit is set in the bit field returned by Expression.getDependencies(), the eval method will be called once for every item in the context sequence. The contextItem parameter will be set to the current item. Otherwise, the eval method will only be called once for the whole context sequence and contextItem will be null. eXist tries to process the entire context set in one, single step whenever possible. Thus, most classes only expect context to contain a list of nodes which represents the current context of the expression. The position() function in XPath is an example for an expression, which requires both, context sequence and context item to be set. The context sequence might be a node set, a sequence of atomic values or a single node or atomic value.

Specified by:

eval in interface Expression

Specified by:

eval in class Function

Parameters:

contextSequence - the current context sequence.

contextItem - a single item, taken from context. This defines the item, the expression should work on.

Throws:

XPathException

eval

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

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.

Parameters:

args -

contextSequence -

Throws:

XPathException