java.lang.Object
org.litebridge.orm.api.register.FieldColumnSpecBuilderJoinStep
- All Implemented Interfaces:
FieldColumnSpecBuilderTerminal
- Direct Known Subclasses:
FcsbJoinStepMultiColumn
public sealed class FieldColumnSpecBuilderJoinStep
extends Object
implements FieldColumnSpecBuilderTerminal
permits FcsbJoinStepMultiColumn
A builder step for defining the join column mapping in a field-to-database-column specification.
This class allows specifying a join column as part of the mapping configuration while building
field specifications for an Object-Relational Mapping (ORM) system.
This class is immutable and part of a step-by-step fluent API to configure ORM mappings, ensuring that only valid sequences of method calls are made during the configuration process.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final @Nullable List<FieldColumnSpec> protected final FieldSpec -
Constructor Summary
ConstructorsConstructorDescriptionFieldColumnSpecBuilderJoinStep(FieldSpec fieldSpec, String column, String joinColumn) Constructs a newFieldColumnSpecBuilderJoinStep.FieldColumnSpecBuilderJoinStep(FieldSpec fieldSpec, String column, String joinColumn, @Nullable List<FieldColumnSpec> columnMappings) -
Method Summary
Modifier and TypeMethodDescriptionwithMappedTable(Class<?> dtoClass, Function<RegistrationContext, RegistrationContextTerminal> rc) Maps the current column configuration to a database table associated with the specified Data Transfer Object (DTO) class.
-
Field Details
-
fieldSpec
-
existingColumnMappings
-
-
Constructor Details
-
FieldColumnSpecBuilderJoinStep
Constructs a newFieldColumnSpecBuilderJoinStep.- Parameters:
fieldSpec- the field specification.column- the column name.joinColumn- the join column name.
-
FieldColumnSpecBuilderJoinStep
public FieldColumnSpecBuilderJoinStep(FieldSpec fieldSpec, String column, String joinColumn, @Nullable List<FieldColumnSpec> columnMappings)
-
-
Method Details
-
withMappedTable
public FieldColumnSpecBuilderTerminal withMappedTable(Class<?> dtoClass, Function<RegistrationContext, RegistrationContextTerminal> rc) Maps the current column configuration to a database table associated with the specified Data Transfer Object (DTO) class. This method resolves the table mapping for the provided DTO class and applies the necessary context transformations via the given function to finalise the table specification for the column mapping.- Parameters:
dtoClass- The class of the Data Transfer Object (DTO) that will be mapped to the database table.rc- A function that processes the registration context, allowing additional mapping configurations or custom transformations, and returns a terminal registration context.- Returns:
- An instance of
FieldColumnSpecBuilderTerminalrepresenting the final step in the field-to-database-column mapping configuration.
-