org.compass.annotations
Enum Store

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

public enum Store
extends Enum<Store>

Specifies whether and how a meta-data property will be stored.

Author:
kimchy

Enum Constant Summary
COMPRESS
          Store the original property value in the index in a compressed form.
NA
          Let Copmass derive the store.
NO
          Do not store the property value in the index.
YES
          Store the original property value in the index.
 
Method Summary
static Store valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Store[] 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 Store NA
Let Copmass derive the store. By default, it will be YES.


NO

public static final Store NO
Do not store the property value in the index.


YES

public static final Store YES
Store the original property value in the index. This is useful for short texts like a document's title which should be displayed with the results. The value is stored in its original form, i.e. no analyzer is used before it is stored.


COMPRESS

public static final Store COMPRESS
Store the original property value in the index in a compressed form. This is useful for long documents and for binary valued fields.

Method Detail

values

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

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

valueOf

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