KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/search/documents/I_CmsSearchExtractor.java,v $
3  * Date : $Date: 2005/06/26 12:51:32 $
4  * Version: $Revision: 1.5 $
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 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 import org.opencms.file.CmsObject;
35 import org.opencms.main.CmsException;
36 import org.opencms.search.A_CmsIndexResource;
37 import org.opencms.search.extractors.I_CmsExtractionResult;
38
39 /**
40  * Defines a text extractor for the integrated search engine.<p>
41  *
42  * The job of a search extractor is to extract indexable plain text from
43  * a resource in the OpenCms VFS. This may be from the resource content, for example
44  * from a PDF file, or from the resource properties, for example the Title, Keywords and
45  * Description properties.<p>
46  *
47  * @author Carsten Weinholz
48  *
49  * @version $Revision: 1.5 $
50  *
51  * @since 6.0.0
52  */
53 public interface I_CmsSearchExtractor {
54
55     /**
56      * Extractes the content of a given resource according to the resource file type.<p>
57      *
58      * @param cms the cms object
59      * @param resource a cms resource
60      * @param language the requested language
61      * @return the extracted content of the resource
62      * @throws CmsException if somethin goes wrong
63      */
64     I_CmsExtractionResult extractContent(CmsObject cms, A_CmsIndexResource resource, String JavaDoc language)
65     throws CmsException;
66
67 }
Popular Tags