Package org.hibernate.search.engine.backend.types

Enum TermVector

java.lang.Object
java.lang.Enum<TermVector>
org.hibernate.search.engine.backend.types.TermVector
All Implemented Interfaces:
Serializable, Comparable<TermVector>
public enum TermVector extends Enum<TermVector>
Defines the term vector storing strategy.

  • Enum Constant Details

    • DEFAULT

      public static final TermVector DEFAULT
      Use the backend-specific default.

    • YES

      public static final TermVector YES
      Store term vectors.

    • NO

      public static final TermVector NO
      Do not store term vectors.

    • WITH_POSITIONS

      public static final TermVector WITH_POSITIONS
      Store the term vectors. Also store token positions into the term.

    • WITH_OFFSETS

      public static final TermVector WITH_OFFSETS
      Store the term vectors. Also store token character offsets into the term.

    • WITH_POSITIONS_OFFSETS

      public static final TermVector WITH_POSITIONS_OFFSETS
      Store the term vectors. Also store token positions and token character offsets into the term.

    • WITH_POSITIONS_PAYLOADS

      public static final TermVector WITH_POSITIONS_PAYLOADS
      Store the term vectors. Also store token positions and token payloads into the term.

    • WITH_POSITIONS_OFFSETS_PAYLOADS

      public static final TermVector WITH_POSITIONS_OFFSETS_PAYLOADS
      Store the term vectors. Also store token positions, token character offsets and token payloads into the term.

  • Method Details

    • values

      public static TermVector[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are 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
      NullPointerException - if the argument is null