001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.jsp.search.config;
029
030/** The interface a field facet configuration must implement. */
031public interface I_CmsSearchConfigurationFacetField extends I_CmsSearchConfigurationFacet {
032
033    /** Returns the index field that is used for the facet.
034     * @return The index field that is used for the facet.
035     */
036    String getField();
037
038    /** Returns the maximal number of entries that should be shown in the facet.
039     * @return The maximal number of entries that should be shown in the facet. (Solr: facet.limit)
040     */
041    Integer getLimit();
042
043    /** Returns the prefix all entries of a facet must match.
044     * @return The prefix all entries of a facet must match. (Solr: facet.prefix)
045     */
046    String getPrefix();
047
048    /** Returns the sort order that should be used for the facet entries (either "count" or "index").
049     * @return The sort order that should be used for the facet entries (either "count" or "index"). (Solr: facet.sort)
050     */
051    SortOrder getSortOrder();
052
053    /** Returns the (modified) filter query that should be send as filter query when a facet entry is checked.
054     * @param facetValue The modifier that should be applied the each filter query appended when checking a facet entry.
055     * The modifier can contain the macro "%(value)" that is substituted by the facet entry's value.
056     * If the modifier is <code>null</code>, the unmodified filter query is returned.
057     * @return The filter query's value.
058     */
059    String modifyFilterQuery(String facetValue);
060}