org.exist.xquery.functions
Class FunGetDateComponent

java.lang.Object
  org.exist.xquery.AbstractExpression
      org.exist.xquery.PathExpr
          org.exist.xquery.Function
              org.exist.xquery.functions.FunGetDateComponent

All Implemented Interfaces:

CompiledXQuery, Expression

public class FunGetDateComponent

extends Function

Author:

Wolfgang Meier (wolfgang@exist-db.org)

Field Summary

static FunctionSignature	fnGetDayFromDate
static FunctionSignature	fnGetMonthFromDate
static FunctionSignature	fnGetTimezoneFromDate
static FunctionSignature	fnGetYearFromDate

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

FunGetDateComponent(XQueryContext context, FunctionSignature signature)

Method Summary

Sequence

eval(Sequence contextSequence, Item contextItem) Evaluate the expression represented by this object.

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

Field Detail

fnGetDayFromDate

public static final FunctionSignature fnGetDayFromDate

fnGetMonthFromDate

public static final FunctionSignature fnGetMonthFromDate

fnGetYearFromDate

public static final FunctionSignature fnGetYearFromDate

fnGetTimezoneFromDate

public static final FunctionSignature fnGetTimezoneFromDate

Constructor Detail

FunGetDateComponent

public FunGetDateComponent(XQueryContext context,
                           FunctionSignature signature)

Parameters:

context -

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

Throws:

XPathException