Package org.opencms.jsp.search.state

Class CmsSearchStateFacet

java.lang.Object

org.opencms.jsp.search.state.CmsSearchStateFacet

All Implemented Interfaces:

I_CmsSearchStateFacet

public class CmsSearchStateFacet
extends java.lang.Object
implements I_CmsSearchStateFacet

Class for keeping the state common for all facet types.

Constructor Summary

Constructors

Constructor	Description
CmsSearchStateFacet()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addChecked(java.lang.String entry)	Add a facet entry to the collection of checked entries.
void	clearChecked()	Clear the collection of checked entries - i.e., tell that nothing is checked.
java.util.List<java.lang.String>	getCheckedEntries()	Returns all checked entries of a facet.
boolean	getIgnoreChecked()	Returns a flag, indicating if the checked entries should be ignored.
java.util.Map<java.lang.String,java.lang.Boolean>	getIsChecked()	Returns a map that tells for each facet entry (an arbitrary string), if it is checked.
boolean	getUseLimit()	Returns a flag, indicating if the limit for the maximal number of facet entries should be used.
void	setIgnoreChecked(boolean ignore)	Set, if the checked facet entries should be ignored.
void	setUseLimit(boolean useLimit)	Set, if the limit for the maximal number of facet entries should be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSearchStateFacet

public CmsSearchStateFacet()

Default constructor.

Method Detail

addChecked

public void addChecked(java.lang.String entry)

Description copied from interface: I_CmsSearchStateFacet

Add a facet entry to the collection of checked entries.

Specified by:

addChecked in interface I_CmsSearchStateFacet

Parameters:

entry - The facet entry.

See Also:

I_CmsSearchStateFacet.addChecked(java.lang.String)

clearChecked

public void clearChecked()

Description copied from interface: I_CmsSearchStateFacet

Clear the collection of checked entries - i.e., tell that nothing is checked.

Specified by:

clearChecked in interface I_CmsSearchStateFacet

See Also:

I_CmsSearchStateFacet.clearChecked()

getCheckedEntries

public java.util.List<java.lang.String> getCheckedEntries()

Description copied from interface: I_CmsSearchStateFacet

Returns all checked entries of a facet.

Specified by:

getCheckedEntries in interface I_CmsSearchStateFacet

Returns:

List of the facet's entries that are checked.

See Also:

I_CmsSearchStateFacet.getCheckedEntries()

getIgnoreChecked

public boolean getIgnoreChecked()

Description copied from interface: I_CmsSearchStateFacet

Returns a flag, indicating if the checked entries should be ignored.

Specified by:

getIgnoreChecked in interface I_CmsSearchStateFacet

Returns:

Flag, indicating if the checked entries should be ignored.

See Also:

I_CmsSearchStateFacet.getIgnoreChecked()

getIsChecked

public java.util.Map<java.lang.String,java.lang.Boolean> getIsChecked()

Description copied from interface: I_CmsSearchStateFacet

Returns a map that tells for each facet entry (an arbitrary string), if it is checked.

Specified by:

getIsChecked in interface I_CmsSearchStateFacet

Returns:

Map from facet entries to their check state.

See Also:

I_CmsSearchStateFacet.getIsChecked()

getUseLimit

public boolean getUseLimit()

Description copied from interface: I_CmsSearchStateFacet

Returns a flag, indicating if the limit for the maximal number of facet entries should be used.

Specified by:

getUseLimit in interface I_CmsSearchStateFacet

Returns:

A flag, indicating if the limit for the maximal number of facet entries should be used.

See Also:

I_CmsSearchStateFacet.getUseLimit()

setIgnoreChecked

public void setIgnoreChecked(boolean ignore)

Description copied from interface: I_CmsSearchStateFacet

Set, if the checked facet entries should be ignored. (This influences the generated query part, by (not) adding specific filter queries.)

Specified by:

setIgnoreChecked in interface I_CmsSearchStateFacet

Parameters:

ignore - Flag, indicating if the checked entries should be ignored or not.

See Also:

I_CmsSearchStateFacet.setIgnoreChecked(boolean)

setUseLimit

public void setUseLimit(boolean useLimit)

Description copied from interface: I_CmsSearchStateFacet

Set, if the limit for the maximal number of facet entries should be used.

Specified by:

setUseLimit in interface I_CmsSearchStateFacet

Parameters:

useLimit - Flag, indicating if the configured limit for the maximal number of facet entries should be used.

See Also:

I_CmsSearchStateFacet.setUseLimit(boolean)