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

Annotation Type DocumentId

@Documented
@Target({METHOD,FIELD})
@Retention(RUNTIME)
@PropertyMapping(processor=@PropertyMappingAnnotationProcessorRef(type=org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.impl.DocumentIdProcessor.class,retrieval=CONSTRUCTOR))
public @interface DocumentId

Maps a property to the identifier of documents in the index.

This annotation is only taken into account on Indexed types.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
IdentifierBinderRef	identifierBinder
IdentifierBridgeRef	identifierBridge

Element Details

identifierBridge

IdentifierBridgeRef identifierBridge

Returns:

A reference to the identifier bridge to use for document IDs. Must not be set if identifierBinder() is set.

See Also:

• IdentifierBridgeRef

Default:

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

identifierBinder

IdentifierBinderRef identifierBinder

Returns:

A reference to the identifier binder to use for document IDs. Must not be set if identifierBridge() is set.

See Also:

• IdentifierBinderRef

Default:

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