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
030import java.util.Collection;
031
032/** The interface a field facet configuration must implement. */
033public interface I_CmsSearchConfigurationFacetRange extends I_CmsSearchConfigurationFacet {
034
035    enum Method {
036        dv, filter
037    }
038
039    enum Other {
040        before, after, between, none, all
041    }
042
043    /**
044     * Returns the value of facet.range.end for the facet.
045     * @return the value of facet.range.end for the facet.
046     */
047    String getEnd();
048
049    /**
050     * Returns the value of facet.range.gap for the facet.
051     * @return the value of facet.range.gap for the facet.
052     */
053    String getGap();
054
055    /**
056     * Returns the value of facet.range.hardend for the facet.
057     * @return the value of facet.range.hardend for the facet.
058     */
059    boolean getHardEnd();
060
061    /**
062     * Returns the value of facet.range.method for the facet, or null if not configured explicitly.
063     * @return the value of facet.range.method for the facet, or null if not configured explicitly.
064     */
065    Method getMethod();
066
067    /**
068     * Returns the values of facet.range.other for the facet.
069     * @return the values of facet.range.other for the facet.
070     */
071    Collection<Other> getOther();
072
073    /** Returns the numeric index field that is used for the facet, i.e., the value of facet.range.
074     * @return The numeric index field that is used for the facet, i.e., the value of facet.range.
075     */
076    String getRange();
077
078    /**
079     * Returns the value of facet.range.start for the facet.
080     * @return the value of facet.range.start for the facet.
081     */
082    String getStart();
083}