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 will be stored.
21: *
22: * @author kimchy
23: */
24: public enum Store {
25: /**
26: * Do not store the property value in the index.
27: */
28: NO,
29:
30: /**
31: * Store the original property value in the index. This is useful for short texts
32: * like a document's title which should be displayed with the results. The value
33: * is stored in its original form, i.e. no analyzer is used before it is stored.
34: */
35: YES,
36:
37: /**
38: * Store the original property value in the index in a compressed form. This is
39: * useful for long documents and for binary valued fields.
40: */
41: COMPRESS
42: }
|