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

Class TypeMappingStepImpl

java.lang.Object

org.hibernate.search.mapper.pojo.mapping.definition.programmatic.impl.TypeMappingStepImpl

All Implemented Interfaces:

PojoSearchMappingTypeNode, PojoTypeMetadataContributor, TypeMappingStep, PojoMappingConfigurationContributor

public class TypeMappingStepImpl
extends Object
implements TypeMappingStep, PojoMappingConfigurationContributor, PojoTypeMetadataContributor

Constructor Summary

Constructors

Constructor	Description
TypeMappingStepImpl(PojoRawTypeModel<?> typeModel)

Method Summary

Modifier and Type	Method	Description
TypeMappingStep	binder(TypeBinder binder, Map<String,Object> params)	Define a type binder, responsible for creating a bridge.
void	configure(MappingBuildContext buildContext, PojoMappingConfigurationContext configurationContext, MappingConfigurationCollector<PojoTypeMetadataContributor> configurationCollector)
ConstructorMappingStep	constructor(Class<?>... parameterTypes)	Starts the definition of the mapping of the constructor of this type accepting arguments with the given types.
Map<List<Class<?>>,? extends PojoSearchMappingConstructorNode>	constructors()
void	contributeAdditionalMetadata(PojoAdditionalMetadataCollectorTypeNode collector)
void	contributeIndexMapping(PojoIndexMappingCollectorTypeNode collector)
TypeMappingIndexedStep	indexed()	Maps an entity type to an index.
ConstructorMappingStep	mainConstructor()	Starts the definition of the mapping of the main constructor of this type.
PropertyMappingStep	property(String propertyName)	Starts the definition of the mapping of a specific property.
TypeMappingSearchEntityStep	searchEntity()	Marks a type as an entity type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.mapper.pojo.mapping.definition.programmatic.TypeMappingStep

binder

Constructor Details

TypeMappingStepImpl

public TypeMappingStepImpl(PojoRawTypeModel<?> typeModel)

Method Details

configure

public void configure(MappingBuildContext buildContext,
 PojoMappingConfigurationContext configurationContext,
 MappingConfigurationCollector<PojoTypeMetadataContributor> configurationCollector)

Specified by:

configure in interface PojoMappingConfigurationContributor

contributeAdditionalMetadata

public void contributeAdditionalMetadata(PojoAdditionalMetadataCollectorTypeNode collector)

Specified by:

contributeAdditionalMetadata in interface PojoTypeMetadataContributor

contributeIndexMapping

public void contributeIndexMapping(PojoIndexMappingCollectorTypeNode collector)

Specified by:

contributeIndexMapping in interface PojoTypeMetadataContributor

indexed

public TypeMappingIndexedStep indexed()

Description copied from interface: TypeMappingStep

Maps an entity type to an index.

Specified by:

indexed in interface TypeMappingStep

Returns:

this, for method chaining.

See Also:

• Indexed

searchEntity

public TypeMappingSearchEntityStep searchEntity()

Description copied from interface: TypeMappingStep

Marks a type as an entity type.

WARNING: this is unnecessary when using the Hibernate ORM integration, which contributes this information automatically, and is in fact unsupported with the Hibernate ORM integration. See HSEARCH-5076 to track progress on allowing the use of `@SearchEntity` in the Hibernate ORM integration to map non-ORM entities.

Specified by:

searchEntity in interface TypeMappingStep

See Also:

• SearchEntity

binder

public TypeMappingStep binder(TypeBinder binder,
 Map<String,Object> params)

Description copied from interface: TypeMappingStep

Define a type binder, responsible for creating a bridge. With this method it is possible to pass a set of parameters to the binder.

Specified by:

binder in interface TypeMappingStep

Parameters:

binder - A TypeBinder responsible for creating a bridge.

params - The parameters to pass to the binder.

Returns:

this, for method chaining.

See Also:

• TypeBinder

mainConstructor

public ConstructorMappingStep mainConstructor()

Description copied from interface: TypeMappingStep

Starts the definition of the mapping of the main constructor of this type.

The main constructor only exists if this type defines a single constructor and that constructor accepts at least one argument.

Specified by:

mainConstructor in interface TypeMappingStep

Returns:

A DSL step where the property mapping can be defined in more details.

constructor

public ConstructorMappingStep constructor(Class<?>... parameterTypes)

Description copied from interface: TypeMappingStep

Starts the definition of the mapping of the constructor of this type accepting arguments with the given types.

Specified by:

constructor in interface TypeMappingStep

Parameters:

parameterTypes - The type of parameters of a constructor in the type being mapped.

Returns:

A DSL step where the property mapping can be defined in more details.

constructors

public Map<List<Class<?>>,? extends PojoSearchMappingConstructorNode> constructors()

Specified by:

constructors in interface PojoSearchMappingTypeNode

Returns:

Search mapping relative to constructors.

property

public PropertyMappingStep property(String propertyName)

Description copied from interface: TypeMappingStep

Starts the definition of the mapping of a specific property.

Specified by:

property in interface TypeMappingStep

Parameters:

propertyName - The name of a property in the type being mapped.

Returns:

A DSL step where the property mapping can be defined in more details.