org.exist.xpath
Class FunFloor

java.lang.Object
  extended byorg.exist.xpath.PathExpr
      extended byorg.exist.xpath.Function
          extended byorg.exist.xpath.FunFloor
All Implemented Interfaces:
Expression

public class FunFloor
extends Function


Field Summary
 
Fields inherited from class org.exist.xpath.Function
name
 
Fields inherited from class org.exist.xpath.PathExpr
docs, inPredicate, keepVirtual, LOG, pool, steps
 
Constructor Summary
FunFloor(BrokerPool pool)
           
 
Method Summary
 Value eval(DocumentSet docs, NodeSet context, NodeProxy node)
          Description of the Method
 java.lang.String pprint()
          Description of the Method
 DocumentSet preselect(DocumentSet in_docs)
          Determine the documents, taken from in_docs, for which this expression will possibly yield a result.
 int returnsType()
          The type of value, this expression returns.
 
Methods inherited from class org.exist.xpath.Function
addArgument, createFunction, getArgument, getArgumentCount, getName
 
Methods inherited from class org.exist.xpath.PathExpr
add, add, addDocument, addPath, addPredicate, getDocumentSet, getExpression, getLength, preselect, setDocumentSet, setFirstExpression, setInPredicate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FunFloor

public FunFloor(BrokerPool pool)
Method Detail

returnsType

public int returnsType()
Description copied from interface: Expression
The type of value, this expression returns. Depending on the type of expression, this method should return one of the constants defined in class Constants, e.g. TYPE_NODELIST, TYPE_STRING, TYPE_NUM, TYPE_BOOL.

Specified by:
returnsType in interface Expression
Overrides:
returnsType in class PathExpr

preselect

public DocumentSet preselect(DocumentSet in_docs)
Description copied from interface: Expression
Determine the documents, taken from in_docs, for which this expression will possibly yield a result. An expression does not have to do anything here. It may simply return in_docs. This method is used to restrict the range of documents in question for a given xpath-expression. It is called before the xpath-expression is actually executed.

Specified by:
preselect in interface Expression
Overrides:
preselect in class PathExpr

eval

public Value eval(DocumentSet docs,
                  NodeSet context,
                  NodeProxy node)
Description copied from class: Function
Description of the Method

Specified by:
eval in interface Expression
Specified by:
eval in class Function
Parameters:
docs - Description of the Parameter
context - Description of the Parameter
node - Description of the Parameter
Returns:
Description of the Return Value

pprint

public java.lang.String pprint()
Description copied from class: Function
Description of the Method

Specified by:
pprint in interface Expression
Overrides:
pprint in class Function
Returns:
Description of the Return Value


Copyright (C) Wolfgang Meier. All rights reserved.