org.hibernate.search.engine.backend.metamodel

Interface IndexValueFieldTypeDescriptor

public interface IndexValueFieldTypeDescriptor

The type of a "value" field in the index, exposing its various capabilities and accepted Java types.

See Also:

IndexValueFieldDescriptor

Method Summary

Modifier and Type	Method and Description
Optional<String>	analyzerName()
Class<?>	dslArgumentClass()
boolean	isAggregable()
boolean	isProjectable()
boolean	isSearchable()
boolean	isSortable()
Optional<String>	normalizerName()
Class<?>	projectedValueClass()
Optional<String>	searchAnalyzerName()
Class<?>	valueClass()

Method Detail

isSearchable

boolean isSearchable()

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).

isSortable

boolean isSortable()

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).

isProjectable

boolean isProjectable()

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).

isAggregable

boolean isAggregable()

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).

dslArgumentClass

Class<?> dslArgumentClass()

Returns:

The expected raw Java type of arguments passed to the DSL for this field.

See Also:

ValueConvert.YES, ToDocumentFieldValueConverter

projectedValueClass

Class<?> projectedValueClass()

Returns:

The raw Java type of projected values for this field.

See Also:

ValueConvert.YES, FromDocumentFieldValueConverter

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.