1 /* Copyright (c) 2008 Sascha Kohlmann
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU Affero General Public License as published by
5 * the Free Software Foundation, either version 3 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU Affero General Public License for more details.
12 *
13 * You should have received a copy of the GNU Affero General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16 package net.sf.eos.lucene;
17
18 import net.sf.eos.document.EosDocument;
19
20 public interface CommonDocument {
21
22 /** The field names. */
23 public enum FieldName {
24 /** The name of the content field. Represents the value of
25 * {@link EosDocument#getText() EosDocument.getText()}.
26 * @see DefaultLuceneDocumentCreator */
27 CONTENT,
28 /** The name of the {@link EosDocument#CREATOR_META_KEY creator} meta
29 * values.
30 * @see DefaultLuceneDocumentCreator */
31 CREATOR,
32 /** The name of the {@link EosDocument#ID_META_KEY ID} meta
33 * values.
34 * @see DefaultLuceneDocumentCreator */
35 ID,
36 /** The name of the {@link EosDocument#YEAR_META_KEY creator} meta
37 * values.
38 * @see DefaultLuceneDocumentCreator */
39 YEAR,
40 }
41 }