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

Interface TypeMappingSearchEntityStep

@Incubating
public interface TypeMappingSearchEntityStep

The step in a mapping definition where a type's entity metadata can be configured more precisely.

Method Summary

Modifier and Type	Method	Description
default TypeMappingSearchEntityStep	loadingBinder(Object binder)	Defines a binder for loading of entities of this type.
default TypeMappingSearchEntityStep	loadingBinder(BeanReference<?> binderRef)	Defines a binder for loading of entities of this type.
TypeMappingSearchEntityStep	loadingBinder(BeanReference<?> binderRef, Map<String,Object> params)	Defines a binder for loading of entities of this type.
TypeMappingSearchEntityStep	name(String entityName)

Method Details

name

TypeMappingSearchEntityStep name(String entityName)

Parameters:

entityName - The name of the entity type. Defaults to the JPA entity name for the Hibernate ORM mapper, or failing that to the simple class name.

Returns:

this, for method chaining.

See Also:

• SearchEntity.name()

loadingBinder

default TypeMappingSearchEntityStep loadingBinder(Object binder)

Defines a binder for loading of entities of this type.

Note: this is unnecessary when using the Hibernate ORM mapper, which contributes this information automatically.

To pass some parameters to the binder, use the method loadingBinder(BeanReference, Map) instead.

Parameters:

binder - A loading binder to apply to the entity type.

Returns:

this, for method chaining.

See Also:

• SearchEntity.loadingBinder()

loadingBinder

default TypeMappingSearchEntityStep loadingBinder(BeanReference<?> binderRef)

Defines a binder for loading of entities of this type.

Note: this is unnecessary when using the Hibernate ORM mapper, which contributes this information automatically.

To pass some parameters to the binder, use the method loadingBinder(BeanReference, Map) instead.

Parameters:

binderRef - A BeanReference to the loading binder to apply to the entity type.

Returns:

this, for method chaining.

See Also:

• SearchEntity.loadingBinder()

loadingBinder

TypeMappingSearchEntityStep loadingBinder(BeanReference<?> binderRef,
 Map<String,Object> params)

Defines a binder for loading of entities of this type.

Note: this is unnecessary when using the Hibernate ORM mapper, which contributes this information automatically.

With this method it is possible to pass a set of parameters to the binder.

Parameters:

binderRef - A BeanReference to the loading binder to apply to the entity type.

params - The parameters to pass to the binder.

Returns:

this, for method chaining.

See Also:

• SearchEntity.loadingBinder()
• EntityLoadingBinderRef.params()