public static enum

Field.TermVector

extends Enum<E extends Enum<E>>
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ org.apache.lucene.document.Field.TermVector

Class Overview

Specifies whether and how a field should have term vectors.

Summary

Enum Values
Field.TermVector  NO  Do not store term vectors. 
Field.TermVector  WITH_OFFSETS  Store the term vector + Token offset information 
Field.TermVector  WITH_POSITIONS  Store the term vector + token position information 
Field.TermVector  WITH_POSITIONS_OFFSETS  Store the term vector + Token position and offset information 
Field.TermVector  YES  Store the term vectors of each document. 
Public Methods
abstract boolean isStored()
static Field.TermVector toTermVector(boolean stored, boolean withOffsets, boolean withPositions)
Get the best representation of a TermVector given the flags.
static Field.TermVector valueOf(String name)
final static TermVector[] values()
abstract boolean withOffsets()
abstract boolean withPositions()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Enum Values

public static final Field.TermVector NO

Do not store term vectors.

public static final Field.TermVector WITH_OFFSETS

Store the term vector + Token offset information

See Also

public static final Field.TermVector WITH_POSITIONS

Store the term vector + token position information

See Also

public static final Field.TermVector WITH_POSITIONS_OFFSETS

Store the term vector + Token position and offset information

public static final Field.TermVector YES

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

Public Methods

public abstract boolean isStored ()

public static Field.TermVector toTermVector (boolean stored, boolean withOffsets, boolean withPositions)

Get the best representation of a TermVector given the flags.

public static Field.TermVector valueOf (String name)

public static final TermVector[] values ()

public abstract boolean withOffsets ()

public abstract boolean withPositions ()