org.exist.xpath
Class FunSubstring

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

public class FunSubstring
extends Function

xpath-library function: string(object)


Field Summary
protected  Expression arg1
           
protected  Expression length
           
protected  Expression start
           
 
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
FunSubstring(BrokerPool pool)
           
FunSubstring(BrokerPool pool, Expression arg1, Expression start, Expression length)
           
 
Method Summary
 Value eval(DocumentSet docs, NodeSet context, NodeProxy node)
          Description of the Method
 java.lang.String pprint()
          Description of the Method
 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, preselect, setDocumentSet, setFirstExpression, setInPredicate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

arg1

protected Expression arg1

start

protected Expression start

length

protected Expression length
Constructor Detail

FunSubstring

public FunSubstring(BrokerPool pool,
                    Expression arg1,
                    Expression start,
                    Expression length)

FunSubstring

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

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.