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 java.lang.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(java.lang.String range, java.lang.String start, java.lang.String end, java.lang.String gap, java.util.Collection<I_CmsSearchConfigurationFacetRange.Other> other, java.lang.Boolean hardEnd, java.lang.String name, java.lang.Integer minCount, java.lang.String label, java.lang.Boolean isAndFacet, java.util.List<java.lang.String> preselection, java.lang.Boolean ignoreFilterFromAllFacets, java.util.Collection<java.lang.String> excludeTags)
Constructor directly setting all configuration values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getEnd()
Returns the value of facet.range.end for the facet.java.lang.String
getGap()
Returns the value of facet.range.gap for the facet.boolean
getHardEnd()
Returns the value of facet.range.hardend for the facet.java.util.Collection<I_CmsSearchConfigurationFacetRange.Other>
getOther()
Returns the values of facet.range.other for the facet.java.lang.String
getRange()
Returns the numeric index field that is used for the facet, i.e., the value of facet.range.java.lang.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 Detail
-
m_range
protected java.lang.String m_range
The range field to use for the facet.
-
-
Constructor Detail
-
CmsSearchConfigurationFacetRange
public CmsSearchConfigurationFacetRange(java.lang.String range, java.lang.String start, java.lang.String end, java.lang.String gap, java.util.Collection<I_CmsSearchConfigurationFacetRange.Other> other, java.lang.Boolean hardEnd, java.lang.String name, java.lang.Integer minCount, java.lang.String label, java.lang.Boolean isAndFacet, java.util.List<java.lang.String> preselection, java.lang.Boolean ignoreFilterFromAllFacets, java.util.Collection<java.lang.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 facetend
- The end of the range of the complete facetgap
- The range of one facet entryother
- The way how to group other valueshardEnd
- Flag, indicating if the last facet item range should end atend
(usetrue
) or extend to the full size ofgap
(usefalse
).name
- The name of the facet. Ifnull
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 Detail
-
getEnd
public java.lang.String getEnd()
Description copied from interface:I_CmsSearchConfigurationFacetRange
Returns the value of facet.range.end for the facet.- Specified by:
getEnd
in interfaceI_CmsSearchConfigurationFacetRange
- Returns:
- the value of facet.range.end for the facet.
- See Also:
I_CmsSearchConfigurationFacetRange.getEnd()
-
getGap
public java.lang.String getGap()
Description copied from interface:I_CmsSearchConfigurationFacetRange
Returns the value of facet.range.gap for the facet.- Specified by:
getGap
in interfaceI_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 interfaceI_CmsSearchConfigurationFacetRange
- Returns:
- the value of facet.range.hardend for the facet.
- See Also:
I_CmsSearchConfigurationFacetRange.getHardEnd()
-
getOther
public java.util.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 interfaceI_CmsSearchConfigurationFacetRange
- Returns:
- the values of facet.range.other for the facet.
- See Also:
I_CmsSearchConfigurationFacetRange.getOther()
-
getRange
public java.lang.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 interfaceI_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 java.lang.String getStart()
Description copied from interface:I_CmsSearchConfigurationFacetRange
Returns the value of facet.range.start for the facet.- Specified by:
getStart
in interfaceI_CmsSearchConfigurationFacetRange
- Returns:
- the value of facet.range.start for the facet.
- See Also:
I_CmsSearchConfigurationFacetRange.getStart()
-
-