org.opencms.search.documents.I_CmsTermHighlighter Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the m_terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.search.documents;
import org.opencms.search.CmsSearchIndex;
import org.opencms.search.CmsSearchParameters;
import java.io.IOException;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.highlight.InvalidTokenOffsetsException;
/**
* Highlights arbitrary terms, used for generation of search excerpts.
*
* @since 6.0.0
*/
public interface I_CmsTermHighlighter {
/**
* Returns an excerpt of the given document related based on the given index and query.
*
* @param doc the content Lucene document to generate the excerpt for
* @param index the index that has been searched
* @param params the current search parameters
* @param query the search query
* @param analyzer the analyzer used
*
* @return an excerpt of the content
*
* @throws IOException if something goes wrong
* @throws InvalidTokenOffsetsException in case of problems with the Lucene tokenizer
*/
String getExcerpt(Document doc, CmsSearchIndex index, CmsSearchParameters params, Query query, Analyzer analyzer)
throws IOException, InvalidTokenOffsetsException;
}