001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.Map;
031
032/** The interface each highlighting configuration must implement. */
033public interface I_CmsSearchConfigurationHighlighting {
034
035    /** Returns the index field whose content should be used if no highlighting snippet is available.
036     * @return The index field whose content should be used if no highlighting snippet is available. (Solr: hl.alternateField)
037     */
038    @Deprecated
039    String getAlternateHighlightField();
040
041    /** Returns the formatter that should be used for highlighting.
042     * @return The formatter that should be used for highlighting. (Solr: hl.formatter)
043     */
044    @Deprecated
045    String getFormatter();
046
047    /** Returns the fragmenter that should be used for highlighting.
048     * @return The fragmenter that should be used for highlighting. (Solr: hl.fragmenter)
049     */
050    @Deprecated
051    String getFragmenter();
052
053    /** Returns the maximal size a highlighted snippet should have.
054     * @return The maximal size a highlighted snippet should have. (Solr: hl.fragsize)
055     */
056    @Deprecated
057    Integer getFragSize();
058
059    /** Returns the index field that should be used for highlighting.
060     * @return The index field that should be used for highlighting.
061     */
062    @Deprecated
063    String getHightlightField();
064
065    /** Returns the maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found.
066     * @return The maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found. (Solr: hl.maxAlternateFieldLength)
067     */
068    @Deprecated
069    Integer getMaxAlternateHighlightFieldLength();
070
071    /**
072     * Returns the value set for the configuration parameter.
073     * @return the value that is set, or <code>null</code> if the value is not set explicitly.
074     */
075    Map<String, String> getParams();
076
077    /** Returns the String that should be inserted directly after the term that should be highlighted.
078     * @return The String that should be inserted directly after the term that should be highlighted. (Solr: hl.simple.post)
079     */
080    @Deprecated
081    String getSimplePost();
082
083    /** Returns the String that should be inserted directly in front of the term that should be highlighted.
084     * @return The String that should be inserted directly in front the term that should be highlighted. (Solr: hl.simple.pre)
085     */
086    @Deprecated
087    String getSimplePre();
088
089    /** Returns the number of highlighted snippets that should be returned.
090     * @return The number of highlighted snippets that should be returned. (Solr: hl.snippets)
091     */
092    @Deprecated
093    Integer getSnippetsCount();
094
095    /** Returns the flag, that indicates if fast vector highlighting should be used.
096     * @return The flag, that indicates if fast vector highlighting should be used. (Solr: hl.useFastVectorHighlighting)
097     */
098    @Deprecated
099    Boolean getUseFastVectorHighlighting();
100
101}