Module litebridge.orm

Package org.litebridge.orm.persistence

Record Class MappingPlan

java.lang.Object

java.lang.Record

org.litebridge.orm.persistence.MappingPlan

Record Components:

dtoClass - the class of the DTO being mapped

ormTable - the ORM table metadata

primaryKeyIndices - the indices of the primary key columns in the row

primaryKeyTypes - the types of the primary key columns

fieldMappings - the mappings for the DTO fields

constructor - the constructor to use for creating DTO instances

defaultConstructorUsed - whether the default constructor is used

canonicalConstructorFieldAccessors - the field accessors for the canonical constructor

joinPlans - the mapping plans for joined DTOs

nestedPlans - the mapping plans for nested DTOs

oneToManyMappings - the mappings for one-to-many relationships

manyToManyMappings - the mappings for many-to-many relationships

public record MappingPlan(Class<?> dtoClass, OrmTable ormTable, int[] primaryKeyIndices, Class<?>[] primaryKeyTypes, MappingPlan.FieldMapping[] fieldMappings, MethodHandle constructor, boolean defaultConstructorUsed, List<FieldAccessor> canonicalConstructorFieldAccessors, Map<DtoJoinSpec,MappingPlan> joinPlans, Map<FieldAccessor,MappingPlan> nestedPlans, List<MappedOneToMany> oneToManyMappings, List<MappedManyToMany> manyToManyMappings)
extends Record

A "pre-compiled" mapping plan for a specific DTO class and query specification. It pre-resolves column indices, constructors, and field mappers to minimize overhead during row processing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MappingPlan.FieldMapping

Constructor Summary

Constructors

Constructor

Description

MappingPlan(Class<?> dtoClass, OrmTable ormTable, int[] primaryKeyIndices, Class<?>[] primaryKeyTypes, MappingPlan.FieldMapping[] fieldMappings, MethodHandle constructor, boolean defaultConstructorUsed, List<FieldAccessor> canonicalConstructorFieldAccessors, Map<DtoJoinSpec,MappingPlan> joinPlans, Map<FieldAccessor,MappingPlan> nestedPlans, List<MappedOneToMany> oneToManyMappings, List<MappedManyToMany> manyToManyMappings)

Creates an instance of a MappingPlan record class.

Method Summary

Modifier and Type	Method	Description
List<FieldAccessor>	canonicalConstructorFieldAccessors()	Returns the value of the canonicalConstructorFieldAccessors record component.
MethodHandle	constructor()	Returns the value of the constructor record component.
boolean	defaultConstructorUsed()	Returns the value of the defaultConstructorUsed record component.
Class<?>	dtoClass()	Returns the value of the dtoClass record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
MappingPlan.FieldMapping[]	fieldMappings()	Returns the value of the fieldMappings record component.
final int	hashCode()	Returns a hash code value for this object.
Map<DtoJoinSpec,MappingPlan>	joinPlans()	Returns the value of the joinPlans record component.
List<MappedManyToMany>	manyToManyMappings()	Returns the value of the manyToManyMappings record component.
Map<FieldAccessor,MappingPlan>	nestedPlans()	Returns the value of the nestedPlans record component.
List<MappedOneToMany>	oneToManyMappings()	Returns the value of the oneToManyMappings record component.
OrmTable	ormTable()	Returns the value of the ormTable record component.
int[]	primaryKeyIndices()	Returns the value of the primaryKeyIndices record component.
Class<?>[]	primaryKeyTypes()	Returns the value of the primaryKeyTypes record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MappingPlan

public MappingPlan(Class<?> dtoClass,
 OrmTable ormTable,
 int[] primaryKeyIndices,
 Class<?>[] primaryKeyTypes,
 MappingPlan.FieldMapping[] fieldMappings,
 MethodHandle constructor,
 boolean defaultConstructorUsed,
 List<FieldAccessor> canonicalConstructorFieldAccessors,
 Map<DtoJoinSpec,MappingPlan> joinPlans,
 Map<FieldAccessor,MappingPlan> nestedPlans,
 List<MappedOneToMany> oneToManyMappings,
 List<MappedManyToMany> manyToManyMappings)

Creates an instance of a MappingPlan record class.

Parameters:

dtoClass - the value for the dtoClass record component

ormTable - the value for the ormTable record component

primaryKeyIndices - the value for the primaryKeyIndices record component

primaryKeyTypes - the value for the primaryKeyTypes record component

fieldMappings - the value for the fieldMappings record component

constructor - the value for the constructor record component

defaultConstructorUsed - the value for the defaultConstructorUsed record component

canonicalConstructorFieldAccessors - the value for the canonicalConstructorFieldAccessors record component

joinPlans - the value for the joinPlans record component

nestedPlans - the value for the nestedPlans record component

oneToManyMappings - the value for the oneToManyMappings record component

manyToManyMappings - the value for the manyToManyMappings record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

dtoClass

public Class<?> dtoClass()

Returns the value of the dtoClass record component.

Returns:

the value of the dtoClass record component

ormTable

public OrmTable ormTable()

Returns the value of the ormTable record component.

Returns:

the value of the ormTable record component

primaryKeyIndices

public int[] primaryKeyIndices()

Returns the value of the primaryKeyIndices record component.

Returns:

the value of the primaryKeyIndices record component

primaryKeyTypes

public Class<?>[] primaryKeyTypes()

Returns the value of the primaryKeyTypes record component.

Returns:

the value of the primaryKeyTypes record component

fieldMappings

public MappingPlan.FieldMapping[] fieldMappings()

Returns the value of the fieldMappings record component.

Returns:

the value of the fieldMappings record component

constructor

public MethodHandle constructor()

Returns the value of the constructor record component.

Returns:

the value of the constructor record component

defaultConstructorUsed

public boolean defaultConstructorUsed()

Returns the value of the defaultConstructorUsed record component.

Returns:

the value of the defaultConstructorUsed record component

canonicalConstructorFieldAccessors

public List<FieldAccessor> canonicalConstructorFieldAccessors()

Returns the value of the canonicalConstructorFieldAccessors record component.

Returns:

the value of the canonicalConstructorFieldAccessors record component

joinPlans

public Map<DtoJoinSpec,MappingPlan> joinPlans()

Returns the value of the joinPlans record component.

Returns:

the value of the joinPlans record component

nestedPlans

public Map<FieldAccessor,MappingPlan> nestedPlans()

Returns the value of the nestedPlans record component.

Returns:

the value of the nestedPlans record component

oneToManyMappings

public List<MappedOneToMany> oneToManyMappings()

Returns the value of the oneToManyMappings record component.

Returns:

the value of the oneToManyMappings record component

manyToManyMappings

public List<MappedManyToMany> manyToManyMappings()

Returns the value of the manyToManyMappings record component.

Returns:

the value of the manyToManyMappings record component