org.exist.xpath
Class FunNear

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

public class FunNear
extends FunContains

near() function.

Author:
Wolfgang Meier

Field Summary
 
Fields inherited from class org.exist.xpath.FunContains
containsExpr, hits, path, terms, type
 
Fields inherited from class org.exist.xpath.Function
name
 
Fields inherited from class org.exist.xpath.PathExpr
docs, inPredicate, keepVirtual, pool, steps
 
Constructor Summary
FunNear(BrokerPool pool)
           
FunNear(BrokerPool pool, PathExpr path, java.lang.String arg)
           
 
Method Summary
 Value eval(DocumentSet docs, NodeSet context, NodeProxy node)
          Description of the Method
 java.lang.String pprint()
          Description of the Method
 void setDistance(int distance)
          Sets the distance attribute of the FunNear object
 
Methods inherited from class org.exist.xpath.FunContains
addTerm, preselect, processQuery, returnsType, setInPredicate, setPath
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FunNear

public FunNear(BrokerPool pool)

FunNear

public FunNear(BrokerPool pool,
               PathExpr path,
               java.lang.String arg)
Method Detail

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
Overrides:
eval in class FunContains

pprint

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

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

setDistance

public void setDistance(int distance)
Sets the distance attribute of the FunNear object

Parameters:
distance - The new distance value


Copyright (C) Wolfgang Meier. All rights reserved.