net.sf.mmm.search.base.config

Class SearchFieldConfigurationBean

java.lang.Object

net.sf.mmm.search.base.config.SearchFieldConfigurationBean

All Implemented Interfaces:

SearchFieldConfiguration

public class SearchFieldConfigurationBean
extends Object
implements SearchFieldConfiguration

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

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchFieldConfigurationBean.XmlAdapterSearchFieldMode
static class	SearchFieldConfigurationBean.XmlAdapterSearchFieldType

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	hidden
private SearchFieldMode	mode
private String	name
private SearchFieldType	type

Constructor Summary

Constructors

Constructor and Description
SearchFieldConfigurationBean() The constructor.
SearchFieldConfigurationBean(String name) The constructor.
SearchFieldConfigurationBean(String name, SearchFieldType type) The constructor.
SearchFieldConfigurationBean(String name, SearchFieldType type, SearchFieldMode mode) The constructor.

Method Summary

Modifier and Type	Method and Description
SearchFieldMode	getMode() This method gets the mode of the field.
String	getName() This method gets the name of the field.
SearchFieldType	getType() This method gets the type of the according field.
boolean	isHidden() This method determines if the represented field shall be hidden in the view.
void	setHidden(boolean hidden)
void	setMode(SearchFieldMode mode)
void	setName(String name)
void	setType(SearchFieldType type)

Methods inherited from class java.lang.Object

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

Field Detail

name

private String name

See Also:

getName()

hidden

private boolean hidden

See Also:

isHidden()

mode

private SearchFieldMode mode

See Also:

getMode()

type

private SearchFieldType type

See Also:

getType()

Constructor Detail

SearchFieldConfigurationBean

public SearchFieldConfigurationBean()

The constructor.

SearchFieldConfigurationBean

public SearchFieldConfigurationBean(String name)

The constructor.
Creates a default field with SearchFieldType.TEXT and SearchFieldMode.SEARCHABLE_AND_RETRIEVABLE.

Parameters:

name - is the name.

SearchFieldConfigurationBean

public SearchFieldConfigurationBean(String name,
                                    SearchFieldType type)

The constructor.
Creates a field with SearchFieldMode.SEARCHABLE_AND_RETRIEVABLE.

Parameters:

name - is the name.

type - is the type.

SearchFieldConfigurationBean

public SearchFieldConfigurationBean(String name,
                                    SearchFieldType type,
                                    SearchFieldMode mode)

The constructor.

Parameters:

name - is the name.

type - is the type.

mode - is the mode.

Method Detail

getName

public String getName()

This method gets the name of the field. It is used as key to identify the field.

Specified by:

getName in interface SearchFieldConfiguration

Returns:

the field-name.

setName

public void setName(String name)

Parameters:

name - is the name to set

getType

public SearchFieldType getType()

This method gets the type of the according field.

Specified by:

getType in interface SearchFieldConfiguration

Returns:

the field-type.

See Also:

SearchEntry.getField(String, Class)

setType

public void setType(SearchFieldType type)

Parameters:

type - is the type to set

getMode

public SearchFieldMode getMode()

This method gets the mode of the field.

Specified by:

getMode in interface SearchFieldConfiguration

Returns:

the SearchFieldMode.

setMode

public void setMode(SearchFieldMode mode)

Parameters:

mode - is the mode to set

isHidden

public boolean isHidden()

This method determines if the represented field shall be hidden in the view. This means it is NOT displayed in the details of a SearchHit. The default is false.

Specified by:

isHidden in interface SearchFieldConfiguration

Returns:

true if hidden, false otherwise.

setHidden

public void setHidden(boolean hidden)

Parameters:

hidden - is the hidden to set