org.compass.core
Enum Property.Index

java.lang.Object
  extended by java.lang.Enum<Property.Index>
      extended by org.compass.core.Property.Index
All Implemented Interfaces:
Serializable, Comparable<Property.Index>
Enclosing interface:
Property

public static enum Property.Index
extends Enum<Property.Index>

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


Enum Constant Summary
ANALYZED
          Index the property's value so it can be searched.
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. renamed to ANALYZED.
UN_TOKENIZED
          Deprecated. renamed to NOT_ANALYZED
 
Method Summary
static Property.Index fromString(String propertyIndex)
           
static String toString(Property.Index propertyIndex)
           
static Property.Index valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Property.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

NO

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


TOKENIZED

public static final Property.Index TOKENIZED
Deprecated. renamed to ANALYZED.

ANALYZED

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


UN_TOKENIZED

public static final Property.Index UN_TOKENIZED
Deprecated. renamed to NOT_ANALYZED

NOT_ANALYZED

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

Method Detail

values

public static final Property.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(Property.Index c : Property.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 Property.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

toString

public static String toString(Property.Index propertyIndex)

fromString

public static Property.Index fromString(String propertyIndex)


Copyright (c) 2004-2009 The Compass Project.