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

Interface LuceneFieldManager

All Superinterfaces:

Refreshable

All Known Implementing Classes:

LuceneFieldManagerImpl

public interface LuceneFieldManager
extends Refreshable

This is the interface for a manager that 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
static String	PROPERTY_PRECISION_STEP The name of the property for LuceneFieldManagerImpl.getPrecisionStep().

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

Field Detail

PROPERTY_PRECISION_STEP

static final String PROPERTY_PRECISION_STEP

The name of the property for LuceneFieldManagerImpl.getPrecisionStep().

See Also:

Constant Field Values

Method Detail

getPrecisionStep

int getPrecisionStep()

Returns:

the precisionStep

createField

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

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

Parameters:

field - is the name of the field to create.

value - is the value of the field to create.

Returns:

the created field.

createTerm

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

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

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

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

This method creates a phrase query.

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

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

This method create a range Query.

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

getConfigurationHolder

SearchConfigurationHolder<? extends SearchConfiguration> getConfigurationHolder()

This method gets the SearchConfigurationHolder.

Returns:

the SearchConfigurationHolder.

refresh

boolean refresh()

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

Returns:

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