org.compass.annotations
Enum ManagedIdIndex

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

public enum ManagedIdIndex
extends Enum<ManagedIdIndex>

Controls the index (see Index) of the internal managed id generated (see ManagedId). Note, that this is an advance mapping setting, which usually should not be set.

Author:
kimchy
See Also:
ManagedId, Index

Enum Constant Summary
NA
          Lets Compass control it.
NO
          Do not index the property value.
NOT_ANALYZED
          Index the property's value without using an Analyzer, so it can be searched.
UN_TOKENIZED
          Deprecated. use NOT_ANALYZED instead.
 
Method Summary
static ManagedIdIndex valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ManagedIdIndex[] 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 ManagedIdIndex NA
Lets Compass control it. Uses compass deafult, or the external setting for it.


NO

public static final ManagedIdIndex 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.


NOT_ANALYZED

public static final ManagedIdIndex 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 ManagedIdIndex UN_TOKENIZED
Deprecated. use NOT_ANALYZED instead.
Method Detail

values

public static final ManagedIdIndex[] 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(ManagedIdIndex c : ManagedIdIndex.values())
        System.out.println(c);

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

valueOf

public static ManagedIdIndex 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.