net.sf.mmm.search.engine.impl.lucene

Class LuceneSearchQueryBuilder

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.search.engine.base.AbstractSearchQueryBuilder

net.sf.mmm.search.engine.impl.lucene.LuceneSearchQueryBuilder

All Implemented Interfaces:

SearchQueryBuilder, Refreshable

public class LuceneSearchQueryBuilder
extends AbstractSearchQueryBuilder

This is the implementation of the SearchQueryBuilder interface using lucene as underlying search-engine.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.lucene.analysis.Analyzer	analyzer The analyzer to use.
private LuceneFieldManager	fieldManager The LuceneFieldManager.
private Boolean	ignoreLeadingWildcard
private org.apache.lucene.util.Version	luceneVersion The Version of lucene.
static LuceneSearchQuery	NULL_QUERY
private static Pattern	PATTERN_NORMALIZE_ASTERISK The pattern to normalize wildcards.
private static Pattern	PATTERN_NORMALIZE_QUESTIONMARK The pattern to normalize wildcards.
static String	PROPERTY_IGNORE_LEADING_WILDCARDS The name of the property for isIgnoreLeadingWildcards().

Constructor Summary

Constructors

Constructor and Description
LuceneSearchQueryBuilder(org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.util.Version version, LuceneFieldManager fieldManager) The constructor.

Method Summary

Modifier and Type	Method and Description
ComplexSearchQuery	createComplexQuery() This method creates a complex query.
protected SearchQuery	createNullQuery() This method creates (or gets) a query that matches anything.
SearchQuery	createPhraseQuery(String field, String phrase) This method creates a new query for the given phrase and property.
SearchQuery	createRangeQuery(String field, String minimum, String maximum, boolean minimumInclusive, boolean maximumInclusive) This method creates a SearchQuery for a range of values.
SearchQuery	createWordQuery(String field, String word) This method creates a new query for the given word and field.
protected org.apache.lucene.analysis.Analyzer	getAnalyzer()
protected org.apache.lucene.util.Version	getLuceneVersion() This method gets the Version.
protected boolean	isIgnoreLeadingWildcards() This method determines if leading wildcards will be ignored.
boolean	refresh() This method refreshes the given object.

Methods inherited from class net.sf.mmm.search.engine.base.AbstractSearchQueryBuilder

parseStandardQuery, parseStandardQuery

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_IGNORE_LEADING_WILDCARDS

public static final String PROPERTY_IGNORE_LEADING_WILDCARDS

The name of the property for isIgnoreLeadingWildcards().

See Also:

Constant Field Values

PATTERN_NORMALIZE_ASTERISK

private static final Pattern PATTERN_NORMALIZE_ASTERISK

The pattern to normalize wildcards.

PATTERN_NORMALIZE_QUESTIONMARK

private static final Pattern PATTERN_NORMALIZE_QUESTIONMARK

The pattern to normalize wildcards.

NULL_QUERY

public static final LuceneSearchQuery NULL_QUERY

See Also:

createNullQuery()

analyzer

private final org.apache.lucene.analysis.Analyzer analyzer

The analyzer to use.

luceneVersion

private final org.apache.lucene.util.Version luceneVersion

The Version of lucene.

ignoreLeadingWildcard

private Boolean ignoreLeadingWildcard

See Also:

isIgnoreLeadingWildcards()

fieldManager

private final LuceneFieldManager fieldManager

The LuceneFieldManager.

Constructor Detail

LuceneSearchQueryBuilder

public LuceneSearchQueryBuilder(org.apache.lucene.analysis.Analyzer analyzer,
                                org.apache.lucene.util.Version version,
                                LuceneFieldManager fieldManager)

The constructor.

Parameters:

analyzer - is the Analyzer.

version - is the Version of lucene.

fieldManager - is the LuceneFieldManager.

Method Detail

isIgnoreLeadingWildcards

protected boolean isIgnoreLeadingWildcards()

This method determines if leading wildcards will be ignored.
ATTENTION:
Leading wildcards can cause performance problems. If you run a public accessible search-engine and you want to avoid easy DOS-attacks, you should disable leading wildcards.

Returns:

true if leading wildcards ('*' or '?') are ignored, false otherwise.

getAnalyzer

protected org.apache.lucene.analysis.Analyzer getAnalyzer()

Returns:

the analyzer

getLuceneVersion

protected org.apache.lucene.util.Version getLuceneVersion()

This method gets the Version.

Returns:

the Version.

createNullQuery

protected SearchQuery createNullQuery()

This method creates (or gets) a query that matches anything.

Overrides:

createNullQuery in class AbstractSearchQueryBuilder

Returns:

a query that matches any entry.

createComplexQuery

public ComplexSearchQuery createComplexQuery()

This method creates a complex query. You can then add sub-queries to this query with logical operations.

Returns:

the created query.

createPhraseQuery

public SearchQuery createPhraseQuery(String field,
                                     String phrase)

This method creates a new query for the given phrase and property.

Parameters:

field - is the name of the field to search.

phrase - is the exact phrase to search for.

Returns:

the created query.

createRangeQuery

public SearchQuery createRangeQuery(String field,
                                    String minimum,
                                    String maximum,
                                    boolean minimumInclusive,
                                    boolean maximumInclusive)

This method creates a SearchQuery for a range of values.

Parameters:

field - is the name of the field(s) to match.

minimum - is the minimum or infimum value.

maximum - is the maximum or supremum value.

minimumInclusive - - true if the minimum is included and matches, false if the minimum is treated as infimum and only higher values will match.

maximumInclusive - - true if the maximum is included and matches, false if the maximum is treated as supremum and only lower values will match.

Returns:

the created range SearchQuery.

createWordQuery

public SearchQuery createWordQuery(String field,
                                   String word)

This method creates a new query for the given word and field.

Parameters:

field - is the name of the field where to search.

word - is the single term or glob pattern (e.g. "moon?i*" to match "moonlight" or "moonride") to search for.

Returns:

the created query.

refresh

public boolean refresh()

This method refreshes the given object. This can be anything from reloading configuration to rebuilding the internal state. An invocation of this method may be expensive and should only be invoked as needed. The implementation of this method should be thread-safe if the object itself is to be used by separate consumers at all.

Returns:

true if something has changed, false otherwise. If the implementation can not determine the change it should return true.