org.compass.core
Enum Property.TermVector

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

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

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


Enum Constant Summary
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 Property.TermVector fromString(String propertyTermVector)
           
static String toString(Property.TermVector propertyTermVector)
           
static Property.TermVector valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Property.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

NO

public static final Property.TermVector NO
Do not store term vectors.


YES

public static final Property.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 Property.TermVector WITH_POSITIONS
Store the term vector + token position information

See Also:
YES

WITH_OFFSETS

public static final Property.TermVector WITH_OFFSETS
Store the term vector + Token offset information

See Also:
YES

WITH_POSITIONS_OFFSETS

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

toString

public static String toString(Property.TermVector propertyTermVector)

fromString

public static Property.TermVector fromString(String propertyTermVector)


Copyright (c) 2004-2009 The Compass Project.