Package org.hibernate.search.engine.backend.metamodel

Interface IndexValueFieldTypeDescriptor

All Superinterfaces:
IndexFieldTypeDescriptor
All Known Implementing Classes:
AbstractIndexValueFieldType
public interface IndexValueFieldTypeDescriptor extends IndexFieldTypeDescriptor
The type of a "value" field in the index, exposing its various capabilities and accepted Java types.
See Also:

  • Method Details

    • searchable

      boolean searchable()
      Returns:
      true if search predicates are supported on fields of this type. Some sorts may still be unsupported because they don't make sense (e.g. a "within circle" predicate on a string field).

    • sortable

      boolean sortable()
      Returns:
      true if sorts are supported on fields of this type. Some sorts may still be unsupported because they don't make sense (e.g. a distance sort aggregation on a string field).

    • projectable

      boolean projectable()
      Returns:
      true if projections are supported on fields of this type. Some projections may still be unsupported because they don't make sense (e.g. a distance projection aggregation on a string field).

    • aggregable

      boolean aggregable()
      Returns:
      true if aggregations are supported on fields of this type. Some aggregations may still be unsupported because they don't make sense (e.g. a range aggregation on an analyzed string field).

    • multivaluable

      @Incubating boolean multivaluable()
      Returns:
      true if the field type allows storing multiple values, false otherwise.

    • dslArgumentClass

      Class<?> dslArgumentClass()
      Returns:
      The expected raw Java type of arguments passed to the DSL for this field.
      See Also:

    • projectedValueClass

      Class<?> projectedValueClass()
      Returns:
      The raw Java type of projected values for this field.
      See Also:

    • valueClass

      Class<?> valueClass()
      Returns:
      The raw Java type of values for this field. This may not be the expected type for arguments passed to the DSL for this field, nor the type of projected values for this field. See dslArgumentClass()

    • analyzerName

      Optional<String> analyzerName()
      Returns:
      The name of the analyzer assigned to this type, if any. Only ever set for String fields.

    • normalizerName

      Optional<String> normalizerName()
      Returns:
      The name of the normalizer assigned to this type, if any. Only ever set for String fields.

    • searchAnalyzerName

      Optional<String> searchAnalyzerName()
      Returns:
      The name of the search analyzer assigned to this type, if any. Only ever set for String fields. By default, the search analyzer is the same as the analyzer.