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

Annotation Type GenericField

@Documented
 @Target(value={METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Repeatable(value=GenericField.List.class)
public @interface GenericField

Maps an entity property to a field in the index.

This is a generic annotation that will work for any type of field supported by the backend: String, Integer, LocalDate, ...

Note that this annotation, being generic, does not offer configuration options that are specific to only some types of fields. Use more specific annotations if you want that kind of configuration. For example, to define a tokenized (multi-word) text field, use FullTextField. To define a non-tokenized (single-word), but normalized (lowercased, ...) text field, use KeywordField.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Aggregable	aggregable
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:

""

projectable

public abstract Projectable projectable

Returns:

Whether projections are enabled for this field.

Default:

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

sortable

public abstract Sortable sortable

Returns:

Whether this field should be sortable.

Default:

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

searchable

public abstract Searchable searchable

Returns:

Whether this field should be searchable.

See Also:

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:

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.

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:

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:

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. This is useful when the property is of container type, for example a Map<TypeA, TypeB>: defining the extraction as @ContainerExtraction(BuiltinContainerExtractors.MAP_KEY) allows binding the field to the map keys instead of the map values. By default, Hibernate Search will try to apply a set of extractors for common container types.

See Also:

ContainerExtraction

Default:

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