lux.functions

Class Exists

java.lang.Object

net.sf.saxon.lib.ExtensionFunctionDefinition

lux.functions.SearchBase

lux.functions.Exists

All Implemented Interfaces:

Serializable

public class Exists
extends SearchBase

function lux:exists($query as item()) as xs:integer

This function tests whether a search has any results. It is faster and uses less memory than calling fn:exists() on the search results themselves because it does not need to load any result documents in memory. See Search for an explanation of the supported $query formats.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class lux.functions.SearchBase

SearchBase.QueryParser, SearchBase.SearchCall

Constructor Summary

Constructors

Constructor and Description
Exists()

Method Summary

Methods

Modifier and Type	Method and Description
net.sf.saxon.om.StructuredQName	getFunctionQName()
net.sf.saxon.value.SequenceType	getResultType(net.sf.saxon.value.SequenceType[] suppliedArgumentTypes)
net.sf.saxon.tree.iter.UnfailingIterator<net.sf.saxon.value.BooleanValue>	iterate(org.apache.lucene.search.Query query, Evaluator saxon, String[] sortCriteria, int start)
protected net.sf.saxon.tree.iter.UnfailingIterator<net.sf.saxon.value.BooleanValue>	iterateDistributed(String query, SearchBase.QueryParser queryParser, Evaluator eval, String[] sortCriteria, int start)
boolean	trustResultType()

Methods inherited from class lux.functions.SearchBase

getArgumentTypes, getEvaluator, getMaximumNumberOfArguments, getMinimumNumberOfArguments, makeCallExpression

Methods inherited from class net.sf.saxon.lib.ExtensionFunctionDefinition

dependsOnFocus, hasSideEffects

Methods inherited from class java.lang.Object

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

Constructor Detail

Exists

public Exists()

Method Detail

getFunctionQName

public net.sf.saxon.om.StructuredQName getFunctionQName()

Specified by:

getFunctionQName in class net.sf.saxon.lib.ExtensionFunctionDefinition

getResultType

public net.sf.saxon.value.SequenceType getResultType(net.sf.saxon.value.SequenceType[] suppliedArgumentTypes)

Specified by:

getResultType in class net.sf.saxon.lib.ExtensionFunctionDefinition

trustResultType

public boolean trustResultType()

Overrides:

trustResultType in class net.sf.saxon.lib.ExtensionFunctionDefinition

iterate

public net.sf.saxon.tree.iter.UnfailingIterator<net.sf.saxon.value.BooleanValue> iterate(org.apache.lucene.search.Query query,
                                                                                Evaluator saxon,
                                                                                String[] sortCriteria,
                                                                                int start)
                                                                                  throws net.sf.saxon.trans.XPathException

Specified by:

iterate in class SearchBase

Throws:

net.sf.saxon.trans.XPathException

iterateDistributed

protected net.sf.saxon.tree.iter.UnfailingIterator<net.sf.saxon.value.BooleanValue> iterateDistributed(String query,
                                                                                           SearchBase.QueryParser queryParser,
                                                                                           Evaluator eval,
                                                                                           String[] sortCriteria,
                                                                                           int start)
                                                                                                throws net.sf.saxon.trans.XPathException

Specified by:

iterateDistributed in class SearchBase

Throws:

net.sf.saxon.trans.XPathException