org.exist.xpath
Class FunKeywordMatch

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

public class FunKeywordMatch
extends Function

xpath-library function: match-keywords(XPATH, arg1, arg2 ...)

Author:
Wolfgang Meier

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
FunKeywordMatch(BrokerPool pool)
          Constructor for the FunKeywordMatch object
 
Method Summary
 Value eval(DocumentSet docs, NodeSet context, NodeProxy node)
          Description of the Method
protected  int getOperatorType()
          Gets the operatorType attribute of the FunKeywordMatch object
 java.lang.String pprint()
          Description of the Method
 DocumentSet preselect(DocumentSet in_docs)
          Description of the Method
 int returnsType()
          Description of the Method
 
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

FunKeywordMatch

public FunKeywordMatch(BrokerPool pool)
Constructor for the FunKeywordMatch object

Method Detail

eval

public Value eval(DocumentSet docs,
                  NodeSet context,
                  NodeProxy node)
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

getOperatorType

protected int getOperatorType()
Gets the operatorType attribute of the FunKeywordMatch object

Returns:
The operatorType value

pprint

public java.lang.String pprint()
Description of the Method

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

preselect

public DocumentSet preselect(DocumentSet in_docs)
Description of the Method

Specified by:
preselect in interface Expression
Overrides:
preselect in class PathExpr
Parameters:
in_docs - Description of the Parameter
Returns:
Description of the Return Value

returnsType

public int returnsType()
Description of the Method

Specified by:
returnsType in interface Expression
Overrides:
returnsType in class PathExpr
Returns:
Description of the Return Value


Copyright (C) Wolfgang Meier. All rights reserved.