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 GmbH & Co. KG, 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.search;
029
030import org.opencms.i18n.CmsLocaleManager;
031
032import java.util.Locale;
033
034/**
035 * An analyzer class is used by Lucene to reduce the content to be indexed
036 * with trimmed endings etc.<p>
037 *
038 * @since 6.0.0
039 */
040public class CmsSearchAnalyzer {
041
042    /** The class name of the analyzer. */
043    private String m_className;
044
045    /** A locale as a key to select the analyzer. */
046    private Locale m_locale;
047
048    /**
049     * Returns the className.<p>
050     *
051     * @return the className
052     */
053    public String getClassName() {
054
055        return m_className;
056    }
057
058    /**
059     * Returns the locale.<p>
060     *
061     * @return the locale
062     */
063    public Locale getLocale() {
064
065        return m_locale;
066    }
067
068    /**
069     * Returns the locale as a String.<p>
070     *
071     * @return the locale as a String
072     *
073     * @see #getLocale()
074     */
075    public String getLocaleString() {
076
077        return getLocale().toString();
078    }
079
080    /**
081     * Sets the class name.<p>
082     *
083     * @param className the class name
084     */
085    public void setClassName(String className) {
086
087        m_className = className;
088    }
089
090    /**
091     * Sets the locale.<p>
092     *
093     * @param locale the locale
094     */
095    public void setLocale(Locale locale) {
096
097        m_locale = locale;
098    }
099
100    /**
101     * Sets the locale as a String.<p>
102     *
103     * @param locale the locale
104     *
105     * @see #setLocale(Locale)
106     */
107    public void setLocaleString(String locale) {
108
109        setLocale(CmsLocaleManager.getLocale(locale));
110    }
111
112}