Interface TypeMappingStep
-
- All Known Implementing Classes:
TypeMappingStepImpl
public interface TypeMappingStepThe step in a mapping definition where a type can be mapped, and where properties of that type can be referenced to map them more precisely.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default TypeMappingStepbinder(TypeBinder binder)Define a type binder, responsible for creating a bridge.TypeMappingStepbinder(TypeBinder binder, Map<String,Object> params)Define a type binder, responsible for creating a bridge.ConstructorMappingStepconstructor(Class<?>... parameterTypes)Starts the definition of the mapping of the constructor of this type accepting arguments with the given types.TypeMappingIndexedStepindexed()Maps an entity type to an index.ConstructorMappingStepmainConstructor()Starts the definition of the mapping of the main constructor of this type.PropertyMappingStepproperty(String propertyName)Starts the definition of the mapping of a specific property.
-
-
-
Method Detail
-
indexed
TypeMappingIndexedStep indexed()
Maps an entity type to an index.- Returns:
this, for method chaining.- See Also:
Indexed
-
binder
default TypeMappingStep binder(TypeBinder binder)
Define a type binder, responsible for creating a bridge. To pass some parameters to the bridge, use the methodbinder(TypeBinder, Map)instead.- Parameters:
binder- ATypeBinderresponsible for creating a bridge.- Returns:
this, for method chaining.- See Also:
TypeBinder
-
binder
TypeMappingStep binder(TypeBinder binder, Map<String,Object> params)
Define a type binder, responsible for creating a bridge. With this method it is possible to pass a set of parameters to the binder.- Parameters:
binder- ATypeBinderresponsible for creating a bridge.params- The parameters to pass to the binder.- Returns:
this, for method chaining.- See Also:
TypeBinder
-
mainConstructor
ConstructorMappingStep mainConstructor()
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.
- Returns:
- A DSL step where the property mapping can be defined in more details.
- Throws:
SearchException- If this type doesn't have a main constructor.
-
constructor
ConstructorMappingStep constructor(Class<?>... parameterTypes)
Starts the definition of the mapping of the constructor of this type accepting arguments with the given types.- 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.
- Throws:
SearchException- If this type does not declare a constructor with the given types.
-
property
PropertyMappingStep property(String propertyName)
Starts the definition of the mapping of a specific property.- 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.
-
-