org.mmbase.module.lucene

Class Searcher

java.lang.Object

org.mmbase.module.lucene.Searcher

All Implemented Interfaces:

EventListener, FullIndexEvents.Listener, NewSearcher.Listener

public class Searcher
extends Object
implements NewSearcher.Listener, FullIndexEvents.Listener

A wrapper around Lucene's IndexSearcher. Every Indexer has its own Searcher.

Version:

$Id$

Author:

Pierre van Rooden

To Do:

Should the StopAnalyzers be replaced by index.analyzer? Something else?

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String[]	allIndexedFields
(package private) static String	FILTER_SYNTAX
(package private) static String	QUERY_SYNTAX

Constructor Summary

Constructors

Constructor and Description
Searcher(Indexer index, String[] allIndexedFields)

Method Summary

Modifier and Type	Method and Description
static org.apache.lucene.search.Filter	createFilter(String constraintsText)
static org.apache.lucene.search.Query	createQuery(String constraintsText) Parses a constraint into a query.
int	getFullIndexSize()
protected org.apache.lucene.search.Hits	getHits(String value, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.search.Query extraQuery, String[] fields, boolean copy)
protected org.apache.lucene.search.Hits	getHits(String value, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.search.Query extraQuery, String[] fields, boolean copy, int explain)
long	getNumberOfProducedNodes()
protected org.apache.lucene.search.Query	getQuery(String value, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.search.Query extraQuery, String[] fields)
protected org.apache.lucene.search.IndexSearcher	getSearcher(boolean copy)
static org.apache.lucene.search.Sort	getSort(String... sortFields)
void	notify(FullIndexEvents.Event event)
void	notify(NewSearcher.Event event)
NodeList	search(Cloud cloud, String value)
NodeList	search(Cloud cloud, String value, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Query extraQuery, int offset, int max)
NodeList	search(Cloud cloud, String value, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.search.Query extraQuery, String[] fields, int offset, int max, int explain)
NodeList	search(Cloud cloud, String value, int offset, int max)
NodeList	search(Cloud cloud, String value, org.apache.lucene.search.Query extraQuery, int offset, int max)
NodeList	search(Cloud cloud, String value, String[] sortFields, org.apache.lucene.search.Query extraQuery, int offset, int max)
NodeList	search(Cloud cloud, String value, String[] sortFields, org.apache.lucene.search.Query extraQuery, int offset, int max, int explain)
List<AnnotatedNode>	searchAnnotated(Cloud cloud, String value, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.search.Query extraQuery, String[] fields, int offset, int max, int explain)
int	searchSize(Cloud cloud, String value)
int	searchSize(Cloud cloud, String value, org.apache.lucene.search.Filter filter, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.search.Query extraQuery, String[] fields, boolean copy)
int	searchSize(Cloud cloud, String value, org.apache.lucene.search.Query extraQuery)
void	shutdown()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

allIndexedFields

final String[] allIndexedFields

QUERY_SYNTAX

static final String QUERY_SYNTAX

See Also:

Constant Field Values

FILTER_SYNTAX

static final String FILTER_SYNTAX

See Also:

Constant Field Values

Constructor Detail

Searcher

Searcher(Indexer index,
         String[] allIndexedFields)

Parameters:

index - The index where this Search is for

Method Detail

notify

public void notify(NewSearcher.Event event)

Specified by:

notify in interface NewSearcher.Listener

notify

public void notify(FullIndexEvents.Event event)

Specified by:

notify in interface FullIndexEvents.Listener

getFullIndexSize

public int getFullIndexSize()

getSearcher

protected org.apache.lucene.search.IndexSearcher getSearcher(boolean copy)
                                                      throws IOException

Throws:

IOException

shutdown

public void shutdown()

search

public NodeList search(Cloud cloud,
                       String value)
                throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

search

public NodeList search(Cloud cloud,
                       String value,
                       int offset,
                       int max)
                throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

search

public NodeList search(Cloud cloud,
                       String value,
                       org.apache.lucene.search.Query extraQuery,
                       int offset,
                       int max)
                throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

search

public NodeList search(Cloud cloud,
                       String value,
                       org.apache.lucene.search.Filter filter,
                       org.apache.lucene.search.Query extraQuery,
                       int offset,
                       int max)
                throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

search

public NodeList search(Cloud cloud,
                       String value,
                       String[] sortFields,
                       org.apache.lucene.search.Query extraQuery,
                       int offset,
                       int max)
                throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

search

public NodeList search(Cloud cloud,
                       String value,
                       String[] sortFields,
                       org.apache.lucene.search.Query extraQuery,
                       int offset,
                       int max,
                       int explain)
                throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

getSort

public static org.apache.lucene.search.Sort getSort(String... sortFields)

searchAnnotated

public List<AnnotatedNode> searchAnnotated(Cloud cloud,
                                           String value,
                                           org.apache.lucene.search.Filter filter,
                                           org.apache.lucene.search.Sort sort,
                                           org.apache.lucene.analysis.Analyzer analyzer,
                                           org.apache.lucene.search.Query extraQuery,
                                           String[] fields,
                                           int offset,
                                           int max,
                                           int explain)
                                    throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

search

public NodeList search(Cloud cloud,
                       String value,
                       org.apache.lucene.search.Filter filter,
                       org.apache.lucene.search.Sort sort,
                       org.apache.lucene.analysis.Analyzer analyzer,
                       org.apache.lucene.search.Query extraQuery,
                       String[] fields,
                       int offset,
                       int max,
                       int explain)
                throws org.apache.lucene.queryParser.ParseException

Throws:

org.apache.lucene.queryParser.ParseException

searchSize

public int searchSize(Cloud cloud,
                      String value)

searchSize

public int searchSize(Cloud cloud,
                      String value,
                      org.apache.lucene.search.Query extraQuery)

searchSize

public int searchSize(Cloud cloud,
                      String value,
                      org.apache.lucene.search.Filter filter,
                      org.apache.lucene.analysis.Analyzer analyzer,
                      org.apache.lucene.search.Query extraQuery,
                      String[] fields,
                      boolean copy)

getQuery

protected org.apache.lucene.search.Query getQuery(String value,
                                                  org.apache.lucene.analysis.Analyzer analyzer,
                                                  org.apache.lucene.search.Query extraQuery,
                                                  String[] fields)
                                           throws IOException,
                                                  org.apache.lucene.queryParser.ParseException

Throws:

IOException

org.apache.lucene.queryParser.ParseException

getHits

protected org.apache.lucene.search.Hits getHits(String value,
                                                org.apache.lucene.search.Filter filter,
                                                org.apache.lucene.search.Sort sort,
                                                org.apache.lucene.analysis.Analyzer analyzer,
                                                org.apache.lucene.search.Query extraQuery,
                                                String[] fields,
                                                boolean copy)
                                         throws IOException,
                                                org.apache.lucene.queryParser.ParseException

Throws:

IOException

org.apache.lucene.queryParser.ParseException

getHits

protected org.apache.lucene.search.Hits getHits(String value,
                                                org.apache.lucene.search.Filter filter,
                                                org.apache.lucene.search.Sort sort,
                                                org.apache.lucene.analysis.Analyzer analyzer,
                                                org.apache.lucene.search.Query extraQuery,
                                                String[] fields,
                                                boolean copy,
                                                int explain)
                                         throws IOException,
                                                org.apache.lucene.queryParser.ParseException

Throws:

IOException

org.apache.lucene.queryParser.ParseException

createFilter

public static org.apache.lucene.search.Filter createFilter(String constraintsText)

createQuery

public static org.apache.lucene.search.Query createQuery(String constraintsText)

Parses a constraint into a query. Constraints are separated by whitespace and of the format: field:[ EQ | GT | GTE | LT | LTE | NE ]:value[:value]

getNumberOfProducedNodes

public long getNumberOfProducedNodes()

Since:

MMBase-1.9

toString

public String toString()

Overrides:

toString in class Object