Package org.hibernate.search.engine.backend.document.model.spi

Enum IndexFieldFilter

java.lang.Object
java.lang.Enum<IndexFieldFilter>
org.hibernate.search.engine.backend.document.model.spi.IndexFieldFilter
All Implemented Interfaces:
Serializable, Comparable<IndexFieldFilter>
public enum IndexFieldFilter extends Enum<IndexFieldFilter>

  • Enum Constant Details

    • ALL

      public static final IndexFieldFilter ALL
      Returns all fields independently from their inclusion.

    • INCLUDED_ONLY

      public static final IndexFieldFilter INCLUDED_ONLY
      Returns fields that are actually included in the schema.

  • Method Details

    • values

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

    • filter

      public abstract <T> T filter(T field, TreeNodeInclusion inclusion)
      Type Parameters:
      T - The type of field.
      Parameters:
      field - The field to filter.
      inclusion - The inclusion of that field (see IndexCompositeNodeBuilder.addField(String, TreeNodeInclusion, IndexFieldType) for example).
      Returns:
      field if it is included; null otherwise.