org.opencms.jsp.search.config

Interface I_CmsSearchConfigurationFacetField

All Superinterfaces:

I_CmsSearchConfigurationFacet

All Known Implementing Classes:

CmsSearchConfigurationFacetField

public interface I_CmsSearchConfigurationFacetField
extends I_CmsSearchConfigurationFacet

The interface a field facet configuration must implement.

Nested Class Summary

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

I_CmsSearchConfigurationFacet.SortOrder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getField() Returns the index field that is used for the facet.
java.lang.Integer	getLimit() Returns the maximal number of entries that should be shown in the facet.
java.lang.String	getPrefix() Returns the prefix all entries of a facet must match.
I_CmsSearchConfigurationFacet.SortOrder	getSortOrder() Returns the sort order that should be used for the facet entries (either "count" or "index").
java.lang.String	modifyFilterQuery(java.lang.String facetValue) Returns the (modified) filter query that should be send as filter query when a facet entry is checked.

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

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

Method Detail

getField

java.lang.String getField()

Returns the index field that is used for the facet.

Returns:

The index field that is used for the facet.

getLimit

java.lang.Integer getLimit()

Returns the maximal number of entries that should be shown in the facet.

Returns:

The maximal number of entries that should be shown in the facet. (Solr: facet.limit)

getPrefix

java.lang.String getPrefix()

Returns the prefix all entries of a facet must match.

Returns:

The prefix all entries of a facet must match. (Solr: facet.prefix)

getSortOrder

I_CmsSearchConfigurationFacet.SortOrder getSortOrder()

Returns the sort order that should be used for the facet entries (either "count" or "index").

Returns:

The sort order that should be used for the facet entries (either "count" or "index"). (Solr: facet.sort)

modifyFilterQuery

java.lang.String modifyFilterQuery(java.lang.String facetValue)

Returns the (modified) filter query that should be send as filter query when a facet entry is checked.

Parameters:

facetValue - The modifier that should be applied the each filter query appended when checking a facet entry. The modifier can contain the macro "%(value)" that is substituted by the facet entry's value. If the modifier is null, the unmodified filter query is returned.

Returns:

The filter query's value.