KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > search > extractors > I_CmsExtractionResult


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/search/extractors/I_CmsExtractionResult.java,v $
3  * Date : $Date: 2005/07/29 12:13:00 $
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.extractors;
33
34 import java.util.Map JavaDoc;
35
36 /**
37  * The result of a document text extraction.<p>
38  *
39  * This data structure contains the extracted text as well as (optional)
40  * meta information extracted from the document.<p>
41  *
42  * @author Alexander Kandzior
43  *
44  * @version $Revision: 1.7 $
45  *
46  * @since 6.0.0
47  */
48 public interface I_CmsExtractionResult {
49
50     /** Key to access the document author name in the meta information map (the value is a <code>{@link String}</code> object). */
51     String JavaDoc META_AUTHOR = "author";
52
53     /** Key to access the document catrgory in the meta information map (the value is a <code>{@link String}</code> object). */
54     String JavaDoc META_CATEGORY = "category";
55
56     /** Key to access the document comments in the meta information map (the value is a <code>{@link String}</code> object). */
57     String JavaDoc META_COMMENTS = "comments";
58
59     /** Key to access the document company name in the meta information map (the value is a <code>{@link String}</code> object). */
60     String JavaDoc META_COMPANY = "company";
61
62     /** Key to access the document creator name in the meta information map (the value is a <code>{@link String}</code> object). */
63     String JavaDoc META_CREATOR = "creator";
64
65     /** Key to access the document creation date in the meta information map (the value is a <code>{@link java.util.Date}</code> object). */
66     String JavaDoc META_DATE_CREATED = "creation date";
67
68     /** Key to access the document date of last modification in the meta information map (the value is a <code>{@link java.util.Date}</code> object). */
69     String JavaDoc META_DATE_LASTMODIFIED = "last modification date";
70
71     /** Key to access the document keywords in the meta information map (the value is a <code>{@link String}</code> object). */
72     String JavaDoc META_KEYWORDS = "keywords";
73
74     /** Key to access the document manager name in the meta information map (the value is a <code>{@link String}</code> object). */
75     String JavaDoc META_MANAGER = "manager";
76
77     /** Key to access the document producer name in the meta information map (the value is a <code>{@link String}</code> object). */
78     String JavaDoc META_PRODUCER = "producer";
79
80     /** Key to access the document subject in the meta information map (the value is a <code>{@link String}</code> object). */
81     String JavaDoc META_SUBJECT = "subject";
82
83     /** Key to access the document title in the meta information map (the value is a <code>{@link String}</code> object). */
84     String JavaDoc META_TITLE = "title";
85
86     /**
87      * Returns the extracted content as a String.<p>
88      *
89      * @return the extracted content as a String
90      */
91     String JavaDoc getContent();
92
93     /**
94      * Returns the extracted meta information.<p>
95      *
96      * The result Map contains all meta information extracted
97      * by the extractor. The key is always a String, and should be one of the constants
98      * defined in the <code>{@link I_CmsExtractionResult}</code> interface. For example
99      * <code>{@link I_CmsExtractionResult#META_TITLE}</code> will contain the document title as
100      * a String.<p>
101      *
102      * @return the extracted meta information
103      */
104     Map JavaDoc getMetaInfo();
105
106     /**
107      * Releases the information stored in this extraction result, to free up the memory used.<p>
108      */
109     void release();
110 }
Popular Tags