net.sf.mmm.search.api.config

Interface SearchProperties

All Known Implementing Classes:

SearchPropertiesBean

public interface SearchProperties

This is the interface for the additional properties to use for the SearchEngine or indexer.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SearchPropertiesBean

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AUTO_REFRESH The key for the auto-refresh option.

Method Summary

Modifier and Type	Method and Description
String	getProperty(String key) This method gets a generic property that may influence the SearchEngine.

Field Detail

KEY_AUTO_REFRESH

static final String KEY_AUTO_REFRESH

The key for the auto-refresh option. A value of "true" indicates that the SearchEngine should be refreshed automatically within a periodically delay.

See Also:

Constant Field Values

Method Detail

getProperty

String getProperty(String key)

This method gets a generic property that may influence the SearchEngine. The properties may be implementation-dependent. Undefined/unsupported properties will simply be ignored.

Parameters:

key - is the key of the requested configuration property.

Returns:

the value of the property for the given key or null if the property is undefined.

See Also:

KEY_AUTO_REFRESH, Map.get(Object), Properties.getProperty(String)