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 proeprty should be indexed.
21: *
22: * @author kimchy
23: */
24: public enum Index {
25: /**
26: * Do not index the property value. This property can thus not be searched, but one
27: * can still access its contents provided it is {@link Store stored}.
28: */
29: NO,
30:
31: /**
32: * Index the property's value so it can be searched. An Analyzer will be used to
33: * tokenize and possibly further normalize the text before its terms will be stored
34: * in the index. This is useful for common text.
35: */
36: TOKENIZED,
37:
38: /**
39: * Index the property's value without using an Analyzer, so it can be searched.
40: * As no analyzer is used the value will be stored as a single term. This is
41: * useful for unique Ids like product numbers.
42: */
43: UN_TOKENIZED
44: }
|