net.sf.mmm.search.base.config

Class SearchFieldsBean

java.lang.Object

net.sf.mmm.search.base.config.SearchFieldsBean

All Implemented Interfaces:

SearchFields

public class SearchFieldsBean
extends Object
implements SearchFields

This is the implementation of SearchFields as JAXB-ready Java-Bean.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private static Map<String,SearchFieldConfigurationBean>	DEFAULTS The defaults for internal fields.
private Map<String,SearchFieldConfigurationBean>	fieldMap
private List<SearchFieldConfigurationBean>	fields

Constructor Summary

Constructors

Constructor and Description
SearchFieldsBean() The constructor.

Method Summary

Modifier and Type	Method and Description
private static void	add(Map<String,SearchFieldConfigurationBean> map, SearchFieldConfigurationBean fieldConfiguration) This method adds the given fieldConfiguration to the given map.
SearchFieldConfigurationBean	getFieldConfiguration(String name) This method gets the SearchFieldConfiguration for the field with the given name .
protected Map<String,SearchFieldConfigurationBean>	getFieldMap() This method gets the Map of fields.
List<SearchFieldConfigurationBean>	getFields() This method gets the List of fields.
SearchFieldConfigurationBean	getOrCreateFieldConfiguration(String name) This method is like SearchFields.getFieldConfiguration(String) but creates a default SearchFieldConfiguration if none is defined.
void	setFields(List<SearchFieldConfigurationBean> fields)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULTS

private static final Map<String,SearchFieldConfigurationBean> DEFAULTS

The defaults for internal fields.

fields

private List<SearchFieldConfigurationBean> fields

See Also:

getFields()

fieldMap

private transient Map<String,SearchFieldConfigurationBean> fieldMap

See Also:

getFieldConfiguration(String)

Constructor Detail

SearchFieldsBean

public SearchFieldsBean()

The constructor.

Method Detail

add

private static void add(Map<String,SearchFieldConfigurationBean> map,
                        SearchFieldConfigurationBean fieldConfiguration)

This method adds the given fieldConfiguration to the given map.

Parameters:

map - is the Map.

fieldConfiguration - is the SearchFieldConfigurationBean.

getFields

public List<SearchFieldConfigurationBean> getFields()

This method gets the List of fields.

Returns:

the fields.

getFieldMap

protected Map<String,SearchFieldConfigurationBean> getFieldMap()

This method gets the Map of fields.

Returns:

the field-map.

setFields

public void setFields(List<SearchFieldConfigurationBean> fields)

Parameters:

fields - is the fields to set

getFieldConfiguration

public SearchFieldConfigurationBean 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.

Specified by:

getFieldConfiguration in interface SearchFields

Parameters:

name - is the name of the requested SearchFieldConfiguration.

Returns:

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

getOrCreateFieldConfiguration

public SearchFieldConfigurationBean getOrCreateFieldConfiguration(String name)

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

Specified by:

getOrCreateFieldConfiguration in interface SearchFields

Parameters:

name - is the name of the requested SearchFieldConfiguration.

Returns:

the requested SearchFieldConfiguration.