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

Annotation Type FieldProjection

@Documented
@Target(PARAMETER)
@Retention(RUNTIME)
@MethodParameterMapping(processor=@MethodParameterMappingAnnotationProcessorRef(type=FieldProjectionProcessor.class,retrieval=CONSTRUCTOR))
public @interface FieldProjection

Maps a constructor parameter to a projection to the value of a field in the indexed document.

See Also:

SearchProjectionFactory.field(String, Class, ValueConvert)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
ValueConvert	convert
String	path

Element Detail

path

String path

Returns:

The path to the index field whose value will be extracted. Defaults to the name of the annotated constructor parameter, if it can be retrieved (requires the class to be compiled with the -parameters flag; otherwise an empty path will lead to a failure).

See Also:

SearchProjectionFactory.field(String, Class)

Default:

""

convert

ValueConvert convert

Returns:

A value controlling how the data fetched from the backend should be converted.

See Also:

ValueConvert, SearchProjectionFactory.field(String, Class, ValueConvert)

Default:

org.hibernate.search.engine.search.common.ValueConvert.YES