net.sf.mmm.search.api.config

Interface SearchFields

All Known Implementing Classes:

SearchFieldsBean

public interface SearchFields

This is the interface for the field-configurations. It defines the meta-model (the schema) of a SearchEntry.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
SearchFieldConfiguration	getFieldConfiguration(String name) This method gets the SearchFieldConfiguration for the field with the given name .
SearchFieldConfiguration	getOrCreateFieldConfiguration(String name) This method is like getFieldConfiguration(String) but creates a default SearchFieldConfiguration if none is defined.

Method Detail

getFieldConfiguration

SearchFieldConfiguration getFieldConfiguration(String name)

This method gets the SearchFieldConfiguration for the field with the given name . This method will always return a result for the fields predefined by SearchEntry (see FIELD_* constants) even if they are NOT explicitly configured. However for specific cases it is possible to override this defaults in your configuration.

Parameters:

name - is the name of the requested SearchFieldConfiguration.

Returns:

the requested SearchFieldConfiguration or null if no such field is defined or configured.

getOrCreateFieldConfiguration

SearchFieldConfiguration getOrCreateFieldConfiguration(String name)

This method is like getFieldConfiguration(String) but creates a default SearchFieldConfiguration if none is defined.

Parameters:

name - is the name of the requested SearchFieldConfiguration.

Returns:

the requested SearchFieldConfiguration.