lux

Class SearchResultIterator

java.lang.Object

lux.SearchIteratorBase

lux.SearchResultIterator

All Implemented Interfaces:

net.sf.saxon.om.SequenceIterator<net.sf.saxon.om.NodeInfo>

public class SearchResultIterator
extends SearchIteratorBase

Executes a Lucene search and provides the results as a Saxon SequenceIterator. Sort criteria are translated into Lucene SortFields: relevance score, intrinsic document order, and field-value orderings are supported.

Field Summary

Fields inherited from class lux.SearchIteratorBase

current, eval, MISSING_LAST, position, sortCriteria, start, stats

Fields inherited from interface net.sf.saxon.om.SequenceIterator

GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
SearchResultIterator(Evaluator eval, org.apache.lucene.search.Query query, String[] sortCriteria, int start1) Executes a Lucene search.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	advanceTo(int startPosition) advance the iterator to (just before) the given (1-based) position.
net.sf.saxon.om.SequenceIterator<net.sf.saxon.om.NodeInfo>	getAnother()
net.sf.saxon.om.NodeInfo	next()

Methods inherited from class lux.SearchIteratorBase

close, current, getProperties, makeSortFromCriteria, position

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultIterator

public SearchResultIterator(Evaluator eval,
                    org.apache.lucene.search.Query query,
                    String[] sortCriteria,
                    int start1)
                     throws IOException

Executes a Lucene search.

Parameters:

eval - provides the link to the index via its IndexSearcher.

query - the query to execute

sortCriteria - sort criteria, formatted as a comma-separated list of sort field names; each name may be followed by ascending|descending, and/or by "empty greatest"|"empty least". The default is "ascending empty least". The sort criteria are Lucene field names, or may be the special name "lux:score", which selects relevance score ranking, which is always sorted in descending order: modifiers on relevance orders are ignored. If no ordering is provided, results are returned in intrinsic document order (ie ordered by document ID).

start1 - the 1-based starting position of the iteration

Throws:

IOException

Method Detail

next

public net.sf.saxon.om.NodeInfo next()
                              throws net.sf.saxon.trans.XPathException

Returns:

the next result. Returns null when there are no more results. Calling this function after null has been returned may result in an error.

Throws:

net.sf.saxon.trans.XPathException - if there is an error while searching

advanceTo

protected void advanceTo(int startPosition)
                  throws IOException

advance the iterator to (just before) the given (1-based) position. Sets current to null: next() must be called after this method in order to retrieve the result at the position.

Parameters:

startPosition -

Throws:

IOException

getAnother

public net.sf.saxon.om.SequenceIterator<net.sf.saxon.om.NodeInfo> getAnother()
                                                                      throws net.sf.saxon.trans.XPathException

Returns:

a clone of this iterator, reset to the initial position.

Throws:

net.sf.saxon.trans.XPathException