Package org.opencms.jsp.search.config

Class CmsSearchConfigurationFacetRange

java.lang.Object

org.opencms.jsp.search.config.CmsSearchConfigurationFacet

org.opencms.jsp.search.config.CmsSearchConfigurationFacetRange

All Implemented Interfaces:

I_CmsSearchConfigurationFacet, I_CmsSearchConfigurationFacetRange

public class CmsSearchConfigurationFacetRange
extends CmsSearchConfigurationFacet
implements I_CmsSearchConfigurationFacetRange

Search configuration special for field facets. Extends @see{org.opencms.jsp.search.config.CmsSearchConfigurationFacet}.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.jsp.search.config.I_CmsSearchConfigurationFacet

I_CmsSearchConfigurationFacet.SortOrder

Nested classes/interfaces inherited from interface org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetRange

I_CmsSearchConfigurationFacetRange.Other

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_range	The range field to use for the facet.

Fields inherited from class org.opencms.jsp.search.config.CmsSearchConfigurationFacet

m_explicitExcludeTags, m_ignoreFacetFilters, m_ignoreTags, m_isAndFacet, m_label, m_minCount, m_name, m_preselection

Constructor Summary

Constructors

Constructor	Description
CmsSearchConfigurationFacetRange(String range, String start, String end, String gap, Collection<I_CmsSearchConfigurationFacetRange.Other> other, Boolean hardEnd, String name, Integer minCount, String label, Boolean isAndFacet, List<String> preselection, Boolean ignoreFilterFromAllFacets, Collection<String> excludeTags)	Constructor directly setting all configuration values.

Method Summary

Modifier and Type	Method	Description
String	getEnd()	Returns the value of facet.range.end for the facet.
String	getGap()	Returns the value of facet.range.gap for the facet.
boolean	getHardEnd()	Returns the value of facet.range.hardend for the facet.
Collection<I_CmsSearchConfigurationFacetRange.Other>	getOther()	Returns the values of facet.range.other for the facet.
String	getRange()	Returns the numeric index field that is used for the facet, i.e., the value of facet.range.
String	getStart()	Returns the value of facet.range.start for the facet.

Methods inherited from class org.opencms.jsp.search.config.CmsSearchConfigurationFacet

getIgnoreAllFacetFilters, getIgnoreMaxParamKey, getIgnoreTags, getIsAndFacet, getLabel, getMinCount, getName, getParamKey, getPreSelection, propagateAllFacetNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.jsp.search.config.I_CmsSearchConfigurationFacet

getIgnoreAllFacetFilters, getIgnoreMaxParamKey, getIgnoreTags, getIsAndFacet, getLabel, getMinCount, getName, getParamKey, getPreSelection, propagateAllFacetNames

Field Details

m_range

protected String m_range

The range field to use for the facet.

Constructor Details

CmsSearchConfigurationFacetRange

public CmsSearchConfigurationFacetRange(String range,
 String start,
 String end,
 String gap,
 Collection<I_CmsSearchConfigurationFacetRange.Other> other,
 Boolean hardEnd,
 String name,
 Integer minCount,
 String label,
 Boolean isAndFacet,
 List<String> preselection,
 Boolean ignoreFilterFromAllFacets,
 Collection<String> excludeTags)

Constructor directly setting all configuration values.

Parameters:

range - The numeric index field to use for the facet.

start - The begin of the range of the complete facet

end - The end of the range of the complete facet

gap - The range of one facet entry

other - The way how to group other values

hardEnd - Flag, indicating if the last facet item range should end at end (use true) or extend to the full size of gap (use false).

name - The name of the facet. If null it defaults to the name of the index field.

minCount - The minimal number of hits that is necessary to add a term to the facet.

label - The label that can be shown over the facet entries in your search form.

isAndFacet - If set to true, the facets filters for results containing all checked entries. Otherwise it filters for results containing at least one checked entry.

preselection - The list of facet items that should be preselected for the first search.

ignoreFilterFromAllFacets - A flag, indicating if filters from all facets should be ignored or not.

excludeTags - The tags (keys) of (filter) queries to be not taken into account for the facet. If "ignoreFiltersFromFacets" is true, the according tags for facets and queries will be added.

Method Details

getEnd

public String getEnd()

Description copied from interface: I_CmsSearchConfigurationFacetRange

Returns the value of facet.range.end for the facet.

Specified by:

getEnd in interface I_CmsSearchConfigurationFacetRange

Returns:

the value of facet.range.end for the facet.

See Also:

• I_CmsSearchConfigurationFacetRange.getEnd()

getGap

public String getGap()

Description copied from interface: I_CmsSearchConfigurationFacetRange

Returns the value of facet.range.gap for the facet.

Specified by:

getGap in interface I_CmsSearchConfigurationFacetRange

Returns:

the value of facet.range.gap for the facet.

See Also:

• I_CmsSearchConfigurationFacetRange.getGap()

getHardEnd

public boolean getHardEnd()

Description copied from interface: I_CmsSearchConfigurationFacetRange

Returns the value of facet.range.hardend for the facet.

Specified by:

getHardEnd in interface I_CmsSearchConfigurationFacetRange

Returns:

the value of facet.range.hardend for the facet.

See Also:

• I_CmsSearchConfigurationFacetRange.getHardEnd()

getOther

public Collection<I_CmsSearchConfigurationFacetRange.Other> getOther()

Description copied from interface: I_CmsSearchConfigurationFacetRange

Returns the values of facet.range.other for the facet.

Specified by:

getOther in interface I_CmsSearchConfigurationFacetRange

Returns:

the values of facet.range.other for the facet.

See Also:

• I_CmsSearchConfigurationFacetRange.getOther()

getRange

public String getRange()

Description copied from interface: I_CmsSearchConfigurationFacetRange

Returns the numeric index field that is used for the facet, i.e., the value of facet.range.

Specified by:

getRange in interface I_CmsSearchConfigurationFacetRange

Returns:

The numeric index field that is used for the facet, i.e., the value of facet.range.

See Also:

• I_CmsSearchConfigurationFacetRange.getRange()

getStart

public String getStart()

Description copied from interface: I_CmsSearchConfigurationFacetRange

Returns the value of facet.range.start for the facet.

Specified by:

getStart in interface I_CmsSearchConfigurationFacetRange

Returns:

the value of facet.range.start for the facet.

See Also:

• I_CmsSearchConfigurationFacetRange.getStart()