KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/search/documents/CmsDocumentGeneric.java,v $
3  * Date : $Date: 2005/06/23 11:11:29 $
4  * Version: $Revision: 1.7 $
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.search.A_CmsIndexResource;
36 import org.opencms.search.CmsIndexException;
37 import org.opencms.search.extractors.CmsExtractionResult;
38 import org.opencms.search.extractors.I_CmsExtractionResult;
39
40 /**
41  * Lucene document factory class for indexing data from a generic <code>{@link org.opencms.file.CmsResource}</code>.<p>
42  *
43  * Since the document type is generic, no content extraction is performed for the resource.
44  * However, meta data from the properties and attributes of the resource are indexed.<p>
45  *
46  * The class is useful for example to have images appear in the search result if the title of the image
47  * matched the search query. It's also used if no specific extraction method is available for a binary document type.<p>
48  *
49  * @author Alexander Kandzior
50  *
51  * @version $Revision: 1.7 $
52  *
53  * @since 6.0.0
54  */
55 public class CmsDocumentGeneric extends A_CmsVfsDocument {
56
57     /**
58      * Creates a new instance of this lucene document factory.<p>
59      *
60      * @param name name of the documenttype
61      */
62     public CmsDocumentGeneric(String JavaDoc name) {
63
64         super(name);
65     }
66
67     /**
68      * Just returns an empty extraction result since the content can't be extracted form a generic resource.<p>
69      *
70      * @see org.opencms.search.documents.A_CmsVfsDocument#extractContent(org.opencms.file.CmsObject, org.opencms.search.A_CmsIndexResource, java.lang.String)
71      */
72     public I_CmsExtractionResult extractContent(CmsObject cms, A_CmsIndexResource resource, String JavaDoc language)
73     throws CmsIndexException {
74
75         if (resource == null) {
76             throw new CmsIndexException(Messages.get().container(Messages.ERR_NO_RAW_CONTENT_1, language));
77         }
78         // just return an empty result set
79 return new CmsExtractionResult("");
80     }
81 }
Popular Tags