Module litebridge.orm

Package org.litebridge.orm.api.dto

Class DtoSelectSpec

java.lang.Object

org.litebridge.orm.api.select.model.SelectSpec

org.litebridge.orm.api.dto.DtoSelectSpec

All Implemented Interfaces:

DtoDataSpec

public final class DtoSelectSpec
extends SelectSpec
implements DtoDataSpec

Specification for a DTO select query.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DtoSelectSpec.FieldColumn	Represents a pair of a field accessor and its corresponding database column.

Field Summary

Fields inherited from class org.litebridge.orm.api.select.model.SelectSpec

expressionSpecs, groupBy, havingConditions, joins, limit, litebridgeContext, orderBys, selectExpressionMapper, table, whereConditions

Constructor Summary

Constructors

Constructor	Description
DtoSelectSpec(Class<?> dtoClass, OrmTable dtoTable, AliasGenerator aliasGenerator, LitebridgeContext litebridgeContext)	Creates a new DtoSelectSpec.

Method Summary

Modifier and Type	Method	Description
List<ExpressionSpec>	createSelectFieldSpecs(String[] fields)	Deprecated, for removal: This API element is subject to removal in a future version.
Class<?>	dtoClass()	Returns the DTO class.
OrmTable	dtoTable()	Returns the ORM table metadata for the DTO.
List<DtoSelectSpec.FieldColumn>	getFieldColumns()	Returns the list of field columns for this select.
DtoJoinSpec	newJoinSpec(Class<?> dtoClass, OrmTable ormTable, Table table)	Creates a new join specification.
DtoJoinSpec	newJoinSpecBefore(DtoJoinSpec other, Class<?> dtoClass, OrmTable ormTable, Table table)	Creates a new join specification before another join specification.

Methods inherited from class org.litebridge.orm.api.select.model.SelectSpec

addExpressions, addHavingCondition, addJoin, addOrderBy, addWhereCondition, convertToSelectExpressionStream, currentHavingConditionGroupSpec, currentWhereConditionGroupSpec, ensureLimit, getExpressions, getGroupBy, getJoins, getLimit, getLitebridgeContext, getOrderBys, getSelectExpressionMapper, getTable, newOrderBy, newOrderBy, popHavingConditionGroup, popWhereConditionGroup, pushHavingConditionGroup, pushWhereConditionGroup, selectExpressionMapper, setExpressions, setGroupBy, setGroupBy, setProtoExpressionResolver, setTable, toSelect

Methods inherited from class java.lang.Object

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

Constructor Details

DtoSelectSpec

public DtoSelectSpec(Class<?> dtoClass,
 OrmTable dtoTable,
 AliasGenerator aliasGenerator,
 LitebridgeContext litebridgeContext)

Creates a new DtoSelectSpec.

Parameters:

dtoClass - the DTO class

dtoTable - the DTO table

aliasGenerator - the alias generator

litebridgeContext - the litebridge context

Method Details

dtoClass

public Class<?> dtoClass()

Returns the DTO class.

Returns:

the DTO class

dtoTable

public OrmTable dtoTable()

Description copied from interface: DtoDataSpec

Returns the ORM table metadata for the DTO.

Specified by:

dtoTable in interface DtoDataSpec

Returns:

the ORM table metadata

newJoinSpec

public DtoJoinSpec newJoinSpec(Class<?> dtoClass,
 OrmTable ormTable,
 Table table)

Creates a new join specification.

Parameters:

dtoClass - the DTO class to join

ormTable - the ORM table to join

table - the database table to join

Returns:

the new join specification

newJoinSpecBefore

public DtoJoinSpec newJoinSpecBefore(DtoJoinSpec other,
 Class<?> dtoClass,
 OrmTable ormTable,
 Table table)

Creates a new join specification before another join specification.

Parameters:

other - the join specification to insert before

dtoClass - the DTO class to join

ormTable - the ORM table to join

table - the database table to join

Returns:

the new join specification

createSelectFieldSpecs

@Deprecated(forRemoval=true)
public List<ExpressionSpec> createSelectFieldSpecs(String[] fields)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates select field specifications for the given fields.

Parameters:

fields - the field names

Returns:

the list of expression specifications

getFieldColumns

public List<DtoSelectSpec.FieldColumn> getFieldColumns()

Returns the list of field columns for this select.

Returns:

the list of field columns