org.apache.xindice.core.query
Class FuncFTContains

java.lang.Object
  org.apache.xpath.Expression
      org.apache.xpath.functions.Function
          org.apache.xpath.functions.FunctionOneArg
              org.apache.xindice.core.query.FuncFTContains

All Implemented Interfaces:

org.apache.xpath.ExpressionNode, org.apache.xpath.ExpressionOwner, Serializable, javax.xml.transform.SourceLocator, org.apache.xpath.XPathVisitable

public class FuncFTContains

extends org.apache.xpath.functions.FunctionOneArg

Full text search extention function for XPath.

Version:

$Revision: 586647 $, $Date: 2007-10-19 20:32:43 -0400 (Fri, 19 Oct 2007) $

See Also:

Serialized Form

Constructor Summary

FuncFTContains()

Method Summary

org.apache.xpath.objects.XObject

execute(org.apache.xpath.XPathContext xctxt) Execute text search function.

Methods inherited from class org.apache.xpath.functions.FunctionOneArg

callArgVisitors, canTraverseOutsideSubtree, checkNumberArgs, deepEquals, fixupVariables, getArg0, getExpression, reportWrongNumberArgs, setArg, setExpression

Methods inherited from class org.apache.xpath.functions.Function

callVisitors, postCompileStep

Methods inherited from class org.apache.xpath.Expression

asIterator, asIteratorRaw, asNode, assertion, bool, error, execute, execute, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isNodesetExpr, isSameClass, isStableNumber, num, warn, xstr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FuncFTContains

public FuncFTContains()

Method Detail

execute

public org.apache.xpath.objects.XObject execute(org.apache.xpath.XPathContext xctxt)
                                         throws javax.xml.transform.TransformerException

Execute text search function. The function returns XBoolean.S_TRUE if the current node text matches the query, XBoolean.S_FALSE otherwise.

Parameters:

xctxt - The current execution context.

Returns:

XBoolean.S_TRUE or XBoolean.S_FALSE.

Throws:

javax.xml.transform.TransformerException