org.hibernate.search.mapper.pojo.mapping.definition.annotation

Annotation Type ScaledNumberField

@Documented
 @Target(value={METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Repeatable(value=ScaledNumberField.List.class)
 @PropertyMapping(processor=@PropertyMappingAnnotationProcessorRef(type=org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.impl.ScaledNumberFieldProcessor.class))
public @interface ScaledNumberField

Maps a property to a scaled number field in the index, i.e. a numeric field for integer or floating-point values that require a higher precision than doubles but always have roughly the same scale.

Useful for BigDecimal and BigInteger in particular.

See Also:

decimalScale()

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Aggregable	aggregable
int	decimalScale
ContainerExtraction	extraction
String	indexNullAs
String	name
Projectable	projectable
Searchable	searchable
Sortable	sortable
ValueBinderRef	valueBinder
ValueBridgeRef	valueBridge

Element Detail

name

public abstract String name

Returns:

The name of the index field.

Default:

""

decimalScale

public abstract int decimalScale

Returns:

How the scale of values should be adjusted before indexing as a fixed-precision integer. A positive decimalScale will shift the decimal point to the right before rounding to the nearest integer and indexing, effectively retaining that many digits after the decimal place in the index. Since numbers are indexed with a fixed number of bits, this increase in precision also means that the maximum value that can be indexed will be smaller. A negative decimalScale will shift the decimal point to the left before rounding to the nearest integer and indexing, effectively setting that many of the smaller digits to zero in the index. Since numbers are indexed with a fixed number of bits, this decrease in precision also means that the maximum value that can be indexed will be larger.

Default:

2147483647

projectable

public abstract Projectable projectable

Returns:

Whether projections are enabled for this field.

See Also:

GenericField.projectable(), Projectable

Default:

org.hibernate.search.engine.backend.types.Projectable.DEFAULT

sortable

public abstract Sortable sortable

Returns:

Whether this field should be sortable.

See Also:

GenericField.sortable(), Sortable

Default:

org.hibernate.search.engine.backend.types.Sortable.DEFAULT

searchable

public abstract Searchable searchable

Returns:

Whether this field should be searchable.

See Also:

GenericField.searchable(), Searchable

Default:

org.hibernate.search.engine.backend.types.Searchable.DEFAULT

aggregable

public abstract Aggregable aggregable

Returns:

Whether aggregations are enabled for this field.

See Also:

GenericField.aggregable(), Aggregable

Default:

org.hibernate.search.engine.backend.types.Aggregable.DEFAULT

indexNullAs

public abstract String indexNullAs

Returns:

A value used instead of null values when indexing.

See Also:

GenericField.indexNullAs()

Default:

"__HibernateSearch_indexNullAs_default"

valueBridge

public abstract ValueBridgeRef valueBridge

Returns:

A reference to the value bridge to use for this field. Must not be set if valueBinder() is set.

See Also:

GenericField.valueBridge(), ValueBridgeRef

Default:

@org.hibernate.search.mapper.pojo.bridge.mapping.annotation.ValueBridgeRef

valueBinder

public abstract ValueBinderRef valueBinder

Returns:

A reference to the value binder to use for this field. Must not be set if valueBridge() is set.

See Also:

GenericField.valueBinder(), ValueBinderRef

Default:

@org.hibernate.search.mapper.pojo.bridge.mapping.annotation.ValueBinderRef

extraction

public abstract ContainerExtraction extraction

Returns:

A definition of container extractors to be applied to the property allowing the binding of a value bridge to container elements. By default, Hibernate Search will try to apply a set of extractors for common container types.

See Also:

GenericField.extraction()

Default:

@org.hibernate.search.mapper.pojo.extractor.mapping.annotation.ContainerExtraction