Enum Constant Detail

• NO

  public static final Field.TermVector NO

  Do not store term vectors.

• YES

  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.

• WITH_POSITIONS

  public static final Field.TermVector WITH_POSITIONS

  Store the term vector + token position information

  See Also:

  YES

• WITH_OFFSETS

  public static final Field.TermVector WITH_OFFSETS

  Store the term vector + Token offset information

  See Also:

  YES

• WITH_POSITIONS_OFFSETS

  public static final Field.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 Field.TermVector[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

  for (Field.TermVector c : Field.TermVector.values())
      System.out.println(c);
  

  Returns:

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

• valueOf

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

  NullPointerException - if the argument is null

• toTermVector

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

  Get the best representation of a TermVector given the flags.

• isStored

  public abstract boolean isStored()

• withPositions

  public abstract boolean withPositions()

• withOffsets

  public abstract boolean withOffsets()