org.compass.annotations
Enum Index

java.lang.Object
  extended by java.lang.Enum<Index>
      extended by org.compass.annotations.Index
All Implemented Interfaces:
Serializable, Comparable<Index>

public enum Index
extends Enum<Index>

Specifies whether and how a meta-data proeprty should be indexed.

Author:
kimchy

Enum Constant Summary
ANALYZED
          Index the property's value so it can be searched.
NA
          Lest Compass derive the index.
NO
          Do not index the property value.
NOT_ANALYZED
          Index the property's value without using an Analyzer, so it can be searched.
TOKENIZED
          Deprecated. use ANALYZED instead.
UN_TOKENIZED
          Deprecated. use NOT_ANALYZED
 
Method Summary
static Index valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Index[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NA

public static final Index NA
Lest Compass derive the index. By default, it will be based on the type and either be TOKENIZED or UN_TOKENIZED.


NO

public static final Index NO
Do not index the property value. This property can thus not be searched, but one can still access its contents provided it is stored.


ANALYZED

public static final Index ANALYZED
Index the property's value so it can be searched. An Analyzer will be used to tokenize and possibly further normalize the text before its terms will be stored in the index. This is useful for common text.


TOKENIZED

public static final Index TOKENIZED
Deprecated. use ANALYZED instead.

NOT_ANALYZED

public static final Index NOT_ANALYZED
Index the property's value without using an Analyzer, so it can be searched. As no analyzer is used the value will be stored as a single term. This is useful for unique Ids like product numbers.


UN_TOKENIZED

public static final Index UN_TOKENIZED
Deprecated. use NOT_ANALYZED
Method Detail

values

public static final Index[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(Index c : Index.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static Index valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name


Copyright (c) 2004-2008 The Compass Project.