org.compass.annotations
Enum TermVector

java.lang.Object
  java.lang.Enum<TermVector>
      org.compass.annotations.TermVector

All Implemented Interfaces:

Serializable, Comparable<TermVector>

public enum TermVector
extends Enum<TermVector>

Specifies whether and how a meta-data property should have term vectors.

Author:

kimchy

Enum Constant Summary

NA
Not applicable.

NO
Do not store term vectors.

WITH_OFFSETS
Store the term vector + Token offset information

WITH_POSITIONS
Store the term vector + token position information

WITH_POSITIONS_OFFSETS
Store the term vector + Token position and offset information

YES
Store the term vectors of each document.

Method Summary

static TermVector	valueOf(String name) Returns the enum constant of this type with the specified name.
static TermVector[]	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 TermVector NA

Not applicable. Where possible, will use a global setting for this.

NO

public static final TermVector NO

Do not store term vectors.

YES

public static final TermVector YES

Store the term vectors of each document. A term vector is a list of the document's terms and their number of occurences in that document.

WITH_POSITIONS

public static final TermVector WITH_POSITIONS

Store the term vector + token position information

See Also:

YES

WITH_OFFSETS

public static final TermVector WITH_OFFSETS

Store the term vector + Token offset information

See Also:

YES

WITH_POSITIONS_OFFSETS

public static final TermVector WITH_POSITIONS_OFFSETS

Store the term vector + Token position and offset information

See Also:

YES, WITH_POSITIONS, WITH_OFFSETS

Method Detail

values

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

Returns:

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

valueOf

public static TermVector 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