org.apache.cocoon.bean.query
Interface SimpleLuceneQuery

All Known Implementing Classes:

SimpleLuceneQueryBean

public interface SimpleLuceneQuery

The interface of a query bean.

This component defines an interface for searching. The idea is to abstract the process of searching into a Bean to be manipulated by CForms.

Version:

CVS $Id: SimpleLuceneQuery.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

static String	AND_BOOL The AND_BOOL name of this bean.
static String	OR_BOOL The OR_BOOL name of this bean.

Method Summary

List	search(LuceneCocoonSearcher searcher) Gets the Bean to perform it's query The searcher specifies which LuceneCocoonSearcher to use for this search It needs to have been initialised properly before use

Field Detail

AND_BOOL

static final String AND_BOOL

The AND_BOOL name of this bean.

The value representing a Boolean AND operation. ie. and

See Also:

Constant Field Values

OR_BOOL

static final String OR_BOOL

The OR_BOOL name of this bean.

The value representing a Boolean OR operation. ie. or

See Also:

Constant Field Values

Method Detail

search

List search(LuceneCocoonSearcher searcher)
            throws IOException,
                   ProcessingException

Gets the Bean to perform it's query

The searcher specifies which LuceneCocoonSearcher to use for this search It needs to have been initialised properly before use

Parameters:

searcher - The LuceneCocoonSearcher to use for this search

Returns:

a List of Maps, each representing a Hit.

Throws:

ProcessingException - thrown by the searcher

IOException - thrown when the searcher's directory cannot be found