org.compass.annotations
Enum ManagedId

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

public enum ManagedId
extends Enum<ManagedId>

For class proeprties (SearchableProperty, and SearchableId, Compass might require an internal meta-data to be created, so it can identify the correct value that match the property and preform proper unmarshalling. Compass can create this internal meta-data automatcially by analyzing all the properties in the class using the AUTO option. It can also not create the internal meta-data using FALSE and use the first meta-data as the intenral id, or always create the intenal meta-data using TRUE. The other options allow to not create an interanl id and never unmarshalling that property (NO), and not creating an internal id in case there all the meta data mappings fro that property have store="no" (NO_STORE).

Author:
kimchy

Enum Constant Summary
AUTO
          Compass will analyzer all the class mappings, and only create an internal id if one is required.
FALSE
          Compass will never create an internal meta-data for the property.
NA
          Not set, will let Compass defaults (on the Searchable mapping and on the global settings) to control this value.
NO
          Compess will not create an internal id for this proeprty.
NO_STORE
          Compass will not create an internal id for this property if all of its meta data created have store="no".
TRUE
          Compass will always create an intenral meta-data for the property.
 
Method Summary
static ManagedId valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ManagedId[] 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 ManagedId NA
Not set, will let Compass defaults (on the Searchable mapping and on the global settings) to control this value.


AUTO

public static final ManagedId AUTO
Compass will analyzer all the class mappings, and only create an internal id if one is required.


TRUE

public static final ManagedId TRUE
Compass will always create an intenral meta-data for the property.


FALSE

public static final ManagedId FALSE
Compass will never create an internal meta-data for the property.


NO

public static final ManagedId NO
Compess will not create an internal id for this proeprty. It will also not try and unmarshall this property from the index.


NO_STORE

public static final ManagedId NO_STORE
Compass will not create an internal id for this property if all of its meta data created have store="no". In this case, it will also not try and unmarshall it from the index.

Method Detail

values

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

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

valueOf

public static ManagedId 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-2009 The Compass Project.