01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.annotations;
18:
19: /**
20: * Specifies whether and how a meta-data property should have term vectors.
21: *
22: * @author kimchy
23: */
24: public enum TermVector {
25: /**
26: * Not applicable. Where possible, will use a global setting for this.
27: */
28: NA,
29:
30: /**
31: * Do not store term vectors.
32: */
33: NO,
34:
35: /**
36: * Store the term vectors of each document. A term vector is a list of
37: * the document's terms and their number of occurences in that document.
38: */
39: YES,
40:
41: /**
42: * Store the term vector + token position information
43: *
44: * @see #YES
45: */
46: WITH_POSITIONS,
47:
48: /**
49: * Store the term vector + Token offset information
50: *
51: * @see #YES
52: */
53: WITH_OFFSETS,
54:
55: /**
56: * Store the term vector + Token position and offset information
57: *
58: * @see #YES
59: * @see #WITH_POSITIONS
60: * @see #WITH_OFFSETS
61: */
62: WITH_POSITIONS_OFFSETS
63: }
|