KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > search > documents > I_CmsTermHighlighter


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/search/documents/I_CmsTermHighlighter.java,v $
3  * Date : $Date: 2005/06/23 11:11:29 $
4  * Version: $Revision: 1.6 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the m_terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */

31
32 package org.opencms.search.documents;
33
34 /**
35  * Highlights arbitrary terms. <p>
36  *
37  * @author Alexander Kandzior
38  *
39  * @version $Revision: 1.6 $
40  *
41  * @since 6.0.0
42  */

43 public interface I_CmsTermHighlighter {
44
45     /**
46      * Highlight an arbitrary term. For example, an HTML I_TermHighlighter could simply do:<p>
47      *
48      * <code>return "&lt;b&gt;" + term + "&lt;/b&gt;";</code><p>
49      *
50      * @param term term text to highlight
51      *
52      * @return highlighted term text
53      */

54     String JavaDoc highlightTerm(String JavaDoc term);
55 }
Popular Tags