org.crosswire.jsword.index.query

Class BaseQuery

java.lang.Object

org.crosswire.jsword.index.query.AbstractQuery

org.crosswire.jsword.index.query.BaseQuery

All Implemented Interfaces:

Query

public class BaseQuery
extends AbstractQuery

A base query is the smallest unit of search that the index can perform.

Author:

DM Smith

See Also:

The GNU Lesser General Public License for details.

Constructor Summary

Constructors

Constructor and Description
BaseQuery(String theQuery) Construct a query from a string.

Method Summary

Methods

Modifier and Type	Method and Description
Key	find(Index index) Find the keys that match the query in the index

Methods inherited from class org.crosswire.jsword.index.query.AbstractQuery

getQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseQuery

public BaseQuery(String theQuery)

Construct a query from a string.

Parameters:

theQuery -

Method Detail

find

public Key find(Index index)
         throws BookException

Description copied from interface: Query

Find the keys that match the query in the index

Parameters:

index - the index to search

Returns:

the set of keys that match

Throws:

BookException