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/** Class keeping the configuration of the "Did you mean ...?" feature of the search form. */
031public class CmsSearchConfigurationDidYouMean implements I_CmsSearchConfigurationDidYouMean {
032
033    /** The default collate setting. */
034    private static final boolean DEFAULT_COLLATE = true;
035    /** Default for maximal number of suggestions. */
036    private static final int DEFAULT_COUNT = 5;
037
038    /** A modifier for the search query. */
039    private final boolean m_collate;
040    /** Parameter used to transmit the query used for spellchecking. */
041    private final String m_param;
042    /** Maximal number of suggestions. */
043    private final int m_count;
044
045    /** Constructor setting all the state.
046     * @param param The request parameter used to send the spellcheck query.
047     * @param collate Flag, indicating if the results should be collated.
048     * @param count The maximal number of suggestions.
049     */
050    public CmsSearchConfigurationDidYouMean(final String param, final Boolean collate, final Integer count) {
051
052        m_param = param;
053        m_collate = null == collate ? DEFAULT_COLLATE : collate.booleanValue();
054        m_count = null == count ? DEFAULT_COUNT : count.intValue();
055
056    }
057
058    /**
059     * @see org.opencms.jsp.search.config.I_CmsSearchConfigurationDidYouMean#getCollate()
060     */
061    public boolean getCollate() {
062
063        return m_collate;
064    }
065
066    /**
067     * @see org.opencms.jsp.search.config.I_CmsSearchConfigurationDidYouMean#getCount()
068     */
069    public int getCount() {
070
071        return m_count;
072    }
073
074    /**
075     * @see org.opencms.jsp.search.config.I_CmsSearchConfigurationDidYouMean#getQueryParam()
076     */
077    public String getQueryParam() {
078
079        return m_param;
080    }
081
082}