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 m_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.documents;
029
030import org.opencms.search.CmsSearchIndex;
031import org.opencms.search.CmsSearchParameters;
032
033import java.io.IOException;
034
035import org.apache.lucene.analysis.Analyzer;
036import org.apache.lucene.document.Document;
037import org.apache.lucene.search.Query;
038import org.apache.lucene.search.highlight.InvalidTokenOffsetsException;
039
040/**
041 * Highlights arbitrary terms, used for generation of search excerpts.<p>
042 *
043 * @since 6.0.0
044 */
045public interface I_CmsTermHighlighter {
046
047    /**
048     * Returns an excerpt of the given document related based on the given index and query.<p>
049     *
050     * @param doc the content Lucene document to generate the excerpt for
051     * @param index the index that has been searched
052     * @param params the current search parameters
053     * @param query the search query
054     * @param analyzer the analyzer used
055     *
056     * @return an excerpt of the content
057     *
058     * @throws IOException if something goes wrong
059     * @throws InvalidTokenOffsetsException in case of problems with the Lucene tokenizer
060     */
061    String getExcerpt(Document doc, CmsSearchIndex index, CmsSearchParameters params, Query query, Analyzer analyzer)
062    throws IOException, InvalidTokenOffsetsException;
063}