Enum Projectable

java.lang.Object
java.lang.Enum<Projectable>
org.hibernate.search.engine.backend.types.Projectable
All Implemented Interfaces:
Serializable, Comparable<Projectable>

public enum Projectable extends Enum<Projectable>
Whether or not we want to be able to obtain the value of the field as a projection.

This usually means that the field will be stored in the index but it is more subtle than that, for instance in the case of projection by distance.

  • Enum Constant Details

    • DEFAULT

      public static final Projectable DEFAULT
      Use the backend-specific default.
      • Lucene's default value is YES
      • Elasticsearch's default value is NO
    • NO

      public static final Projectable NO
      Do not allow projection on the field.
    • YES

      public static final Projectable YES
      Allow projection on the field.
  • Method Details

    • values

      public static Projectable[] 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 Projectable 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