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

Class LuceneFieldManagerImpl

java.lang.Object

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

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

All Implemented Interfaces:

LuceneFieldManager, Refreshable

public class LuceneFieldManagerImpl
extends AbstractLoggableObject
implements LuceneFieldManager

This class centralizes the behavior of fields according to their SearchFieldConfiguration for lucene.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Field, NumericField, Term, NumericRangeQuery, TermRangeQuery

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.lucene.analysis.Analyzer	analyzer The Analyzer
private SearchConfigurationHolder<? extends SearchConfiguration>	configurationHolder
private Iso8601Util	iso8601Util The Iso8601Util for date fields.
private Integer	precisionStep

Fields inherited from interface net.sf.mmm.search.engine.impl.lucene.LuceneFieldManager

PROPERTY_PRECISION_STEP

Constructor Summary

Constructors

Constructor and Description
LuceneFieldManagerImpl(SearchConfigurationHolder<? extends SearchConfiguration> configurationHolder, org.apache.lucene.analysis.Analyzer analyzer, Iso8601Util iso8601Util) The constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.document.Fieldable	createField(String field, Object value) This method creates the field for the given field (name) and value.
org.apache.lucene.search.Query	createPhraseQuery(String field, String value) This method creates a phrase query.
org.apache.lucene.search.Query	createRangeQuery(String field, String minimum, String maximum, boolean minimumInclusive, boolean maximumInclusive) This method create a range Query.
org.apache.lucene.index.Term	createTerm(String field, Object value) This method creates a Term for the given field with the given value.
SearchConfigurationHolder<? extends SearchConfiguration>	getConfigurationHolder() This method gets the SearchConfigurationHolder.
int	getPrecisionStep()
protected SearchFields	getSearchFields() This method gets the SearchFields.
boolean	refresh() Will update LuceneFieldManager.getPrecisionStep() but not refresh LuceneFieldManager.getConfigurationHolder().

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

iso8601Util

private final Iso8601Util iso8601Util

The Iso8601Util for date fields.

configurationHolder

private final SearchConfigurationHolder<? extends SearchConfiguration> configurationHolder

See Also:

getConfigurationHolder()

analyzer

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

The Analyzer

precisionStep

private Integer precisionStep

See Also:

getPrecisionStep()

Constructor Detail

LuceneFieldManagerImpl

public LuceneFieldManagerImpl(SearchConfigurationHolder<? extends SearchConfiguration> configurationHolder,
                              org.apache.lucene.analysis.Analyzer analyzer,
                              Iso8601Util iso8601Util)

The constructor.

Parameters:

configurationHolder - is the SearchConfigurationHolder.

analyzer - the Analyzer.

iso8601Util - is the Iso8601Util instance used to handle Date fields.

Method Detail

getConfigurationHolder

public SearchConfigurationHolder<? extends SearchConfiguration> getConfigurationHolder()

This method gets the SearchConfigurationHolder.

Specified by:

getConfigurationHolder in interface LuceneFieldManager

Returns:

the SearchConfigurationHolder.

getSearchFields

protected SearchFields getSearchFields()

This method gets the SearchFields.

Returns:

the SearchFields.

getPrecisionStep

public int getPrecisionStep()

Specified by:

getPrecisionStep in interface LuceneFieldManager

Returns:

the precisionStep

createField

public org.apache.lucene.document.Fieldable createField(String field,
                                                        Object value)

This method creates the field for the given field (name) and value.

Specified by:

createField in interface LuceneFieldManager

Parameters:

field - is the name of the field to create.

value - is the value of the field to create.

Returns:

the created field.

createTerm

public org.apache.lucene.index.Term createTerm(String field,
                                               Object value)

This method creates a Term for the given field with the given value.

Specified by:

createTerm in interface LuceneFieldManager

Parameters:

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

value - is the expected value of the field(s) to match. Please note that this value is a single term (word) and not text.

Returns:

the created Term.

createPhraseQuery

public org.apache.lucene.search.Query createPhraseQuery(String field,
                                                        String value)

This method creates a phrase query.

Specified by:

createPhraseQuery in interface LuceneFieldManager

Parameters:

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

value - is the expected phrase of the field(s) to match.

Returns:

the created Query.

createRangeQuery

public org.apache.lucene.search.Query createRangeQuery(String field,
                                                       String minimum,
                                                       String maximum,
                                                       boolean minimumInclusive,
                                                       boolean maximumInclusive)

This method create a range Query.

Specified by:

createRangeQuery in interface LuceneFieldManager

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 Query.

See Also:

NumericRangeQuery, TermRangeQuery

refresh

public boolean refresh()

Will update LuceneFieldManager.getPrecisionStep() but not refresh LuceneFieldManager.getConfigurationHolder(). 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.

Specified by:

refresh in interface LuceneFieldManager

Specified by:

refresh in interface Refreshable

Returns:

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