org.exist.xquery.functions
Class ExtFulltext

java.lang.Object
  extended byorg.exist.xquery.AbstractExpression
      extended byorg.exist.xquery.PathExpr
          extended byorg.exist.xquery.Function
              extended byorg.exist.xquery.functions.ExtFulltext
All Implemented Interfaces:
CompiledExpression, CompiledXQuery, Expression
Direct Known Subclasses:
ExtNear, ExtPhrase

public class ExtFulltext
extends Function

Implements the fulltext operators: &= and |=. This is internally handled like a special function and thus inherits from Function.

Author:
wolf

Field Summary
static FunctionSignature signature
           
 
Fields inherited from class org.exist.xquery.Function
BUILTIN_FUNCTION_NS
 
Fields inherited from interface org.exist.xquery.Expression
DOT_TEST, EXPRESSION_ID_INVALID, IGNORE_CONTEXT, IN_PREDICATE, IN_UPDATE, IN_WHERE_CLAUSE, NO_CONTEXT_ID, SINGLE_STEP_EXECUTION
 
Constructor Summary
ExtFulltext(XQueryContext context, int type)
           
ExtFulltext(XQueryContext context, PathExpr path)
           
 
Method Summary
 void addTerm(Expression term)
           
 void analyze(AnalyzeContextInfo contextInfo)
          Statically analyze the expression and its subexpressions.
 int countTerms()
           
 void dump(ExpressionDumper dumper)
          Write a diagnostic dump of the expression to the passed ExpressionDumper.
 Sequence eval(Sequence contextSequence, Item contextItem)
          Evaluate the expression represented by this object.
 Sequence evalQuery(java.lang.String searchArg, NodeSet nodes)
           
 int getDependencies()
          Returns Dependency.DEFAULT_DEPENDENCIES.
 DocumentSet preselect(DocumentSet in_docs)
           
 void resetState()
          Called to inform an expression that it should reset to its initial state.
 int returnsType()
          The static return type of the expression.
 void setContextDocSet(DocumentSet contextSet)
           
 void setPath(PathExpr path)
           
 java.lang.String toString()
           
 
Methods inherited from class org.exist.xquery.Function
createFunction, getArgument, getArgumentCount, getArguments, getASTNode, getCardinality, getName, getParent, getSignature, isCalledAs, setArguments, setASTNode, setParent, setPrimaryAxis
 
Methods inherited from class org.exist.xquery.PathExpr
accept, add, add, addPath, addPredicate, dump, getContext, getDocumentSet, getExpression, getLastExpression, getLength, getLiteralValue, getSource, isValid, replaceLastExpression, reset, setContext, setSource
 
Methods inherited from class org.exist.xquery.AbstractExpression
eval, getContextDocSet, getContextId, getExpressionId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.exist.xquery.CompiledXQuery
eval
 

Field Detail

signature

public static final FunctionSignature signature
Constructor Detail

ExtFulltext

public ExtFulltext(XQueryContext context,
                   int type)

ExtFulltext

public ExtFulltext(XQueryContext context,
                   PathExpr path)
Method Detail

addTerm

public void addTerm(Expression term)

countTerms

public int countTerms()

analyze

public void analyze(AnalyzeContextInfo contextInfo)
             throws XPathException
Description copied from interface: Expression
Statically analyze the expression and its subexpressions. During the static analysis phase, the query engine can detect unknown variables and some type errors.

Specified by:
analyze in interface Expression
Overrides:
analyze in class Function
Throws:
XPathException

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

evalQuery

public Sequence evalQuery(java.lang.String searchArg,
                          NodeSet nodes)
                   throws XPathException
Throws:
XPathException

toString

public java.lang.String toString()
Overrides:
toString in class Function

dump

public void dump(ExpressionDumper dumper)
Description copied from interface: Expression
Write a diagnostic dump of the expression to the passed ExpressionDumper.

Specified by:
dump in interface Expression
Overrides:
dump in class Function

getDependencies

public int getDependencies()
Description copied from class: AbstractExpression
Returns Dependency.DEFAULT_DEPENDENCIES.

Specified by:
getDependencies in interface Expression
Overrides:
getDependencies in class Function

preselect

public DocumentSet preselect(DocumentSet in_docs)

returnsType

public int returnsType()
Description copied from interface: Expression
The static return type of the expression. This method should return one of the type constants defined in class Type. If the return type cannot be determined statically, return Type.ITEM.

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

setPath

public void setPath(PathExpr path)

setContextDocSet

public void setContextDocSet(DocumentSet contextSet)
Specified by:
setContextDocSet in interface Expression
Overrides:
setContextDocSet in class AbstractExpression

resetState

public void resetState()
Description copied from interface: Expression
Called to inform an expression that it should reset to its initial state. All cached data in the expression object should be dropped. For example, the document() function calls this method whenever the input document set has changed.

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


Copyright (C) Wolfgang Meier. All rights reserved.