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 each highlighting configuration must implement. */
031public interface I_CmsSearchConfigurationHighlighting {
032
033    /** Returns the index field whose content should be used if no highlighting snippet is available.
034     * @return The index field whose content should be used if no highlighting snippet is available. (Solr: hl.alternateField)
035     */
036    String getAlternateHighlightField();
037
038    /** Returns the formatter that should be used for highlighting.
039     * @return The formatter that should be used for highlighting. (Solr: hl.formatter)
040     */
041    String getFormatter();
042
043    /** Returns the fragmenter that should be used for highlighting.
044     * @return The fragmenter that should be used for highlighting. (Solr: hl.fragmenter)
045     */
046    String getFragmenter();
047
048    /** Returns the maximal size a highlighted snippet should have.
049     * @return The maximal size a highlighted snippet should have. (Solr: hl.fragsize)
050     */
051    Integer getFragSize();
052
053    /** Returns the index field that should be used for highlighting.
054     * @return The index field that should be used for highlighting.
055     */
056    String getHightlightField();
057
058    /** Returns the maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found.
059     * @return The maximal length of the snippet that should be shown from the alternative field, if no highlighting snippet was found. (Solr: hl.maxAlternateFieldLength)
060     */
061    Integer getMaxAlternateHighlightFieldLength();
062
063    /** Returns the String that should be inserted directly after the term that should be highlighted.
064     * @return The String that should be inserted directly after the term that should be highlighted. (Solr: hl.simple.post)
065     */
066    String getSimplePost();
067
068    /** Returns the String that should be inserted directly in front of the term that should be highlighted.
069     * @return The String that should be inserted directly in front the term that should be highlighted. (Solr: hl.simple.pre)
070     */
071    String getSimplePre();
072
073    /** Returns the number of highlighted snippets that should be returned.
074     * @return The number of highlighted snippets that should be returned. (Solr: hl.snippets)
075     */
076    Integer getSnippetsCount();
077
078    /** Returns the flag, that indicates if fast vector highlighting should be used.
079     * @return The flag, that indicates if fast vector highlighting should be used. (Solr: hl.useFastVectorHighlighting)
080     */
081    Boolean getUseFastVectorHighlighting();
082
083}