Module litebridge.orm

Package org.litebridge.orm.api.dto

Class DtoFromClauseTerminal<DTO>

java.lang.Object

org.litebridge.orm.api.select.impl.DelegatingSelector<DTO,DtoSelectSpec>

org.litebridge.orm.api.select.impl.LimitClauseTerminalImpl<DTO,DtoSelectSpec>

org.litebridge.orm.api.select.impl.OrderByClauseTerminalImpl<DTO,DtoSelectSpec>

org.litebridge.orm.api.select.impl.AbstractWhereClauseTerminal<DTO,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>,DtoSelectSpec>

org.litebridge.orm.api.select.impl.AbstractJoinClauseTerminal<DTO,DtoJoinClause<DTO>,DtoJoinConditionClause<DTO>,DtoJoinConditionClauseTerminal<DTO>,DtoWhereConditionClause<DTO>,DtoWhereConditionClauseTerminal<DTO>,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>,DtoSelectSpec>

org.litebridge.orm.api.select.impl.AbstractFromClauseTerminal<DTO,DtoJoinClause<DTO>,DtoJoinConditionClause<DTO>,DtoJoinConditionClauseTerminal<DTO>,DtoWhereConditionClause<DTO>,DtoWhereConditionClauseTerminal<DTO>,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>,DtoSelectSpec>

org.litebridge.orm.api.dto.DtoFromClauseTerminal<DTO>

Type Parameters:

DTO - the type of the DTO

All Implemented Interfaces:

DtoJoinClassTerminal<DTO>, FromClauseTerminal<DTO,DtoJoinClause<DTO>,DtoJoinConditionClause<DTO>,DtoJoinConditionClauseTerminal<DTO>,DtoWhereConditionClause<DTO>,DtoWhereConditionClauseTerminal<DTO>,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>, JoinClauseTerminal<DTO,DtoJoinClause<DTO>,DtoJoinConditionClause<DTO>,DtoJoinConditionClauseTerminal<DTO>,DtoWhereConditionClause<DTO>,DtoWhereConditionClauseTerminal<DTO>,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>, LimitClauseTerminal<DTO>, OrderByClauseTerminal<DTO>, SelectTerminal<DTO>, WhereClauseTerminal<DTO,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>

public final class DtoFromClauseTerminal<DTO>
extends org.litebridge.orm.api.select.impl.AbstractFromClauseTerminal<DTO,DtoJoinClause<DTO>,DtoJoinConditionClause<DTO>,DtoJoinConditionClauseTerminal<DTO>,DtoWhereConditionClause<DTO>,DtoWhereConditionClauseTerminal<DTO>,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>,DtoSelectSpec>
implements DtoJoinClassTerminal<DTO>

Terminal clause for DTO FROM clauses.

Field Summary

Fields inherited from class org.litebridge.orm.api.select.impl.LimitClauseTerminalImpl

selectSpec

Fields inherited from class org.litebridge.orm.api.select.impl.DelegatingSelector

delegate

Constructor Summary

Constructors

Constructor	Description
DtoFromClauseTerminal(DtoSelector<DTO> delegate)	Creates a new DtoFromClauseTerminal.

Method Summary

Modifier and Type	Method	Description
DtoGroupByClauseTerminal<DTO>	groupBy(String... fields)	Adds a GROUP BY clause to the query, specifying the column(s) to group the results by.
DtoGroupByClauseTerminal<DTO>	groupBy(ExpressionSpec... fields)	Adds a GROUP BY clause to the query, specifying the expressions to group the results by.
DtoJoinClause<DTO>	join(Class<?> dtoClass)	Adds a JOIN clause for the specified DTO class.
DtoOrderByClause<DTO>	orderBy(String... fields)	Adds an ORDER BY clause to the query, specifying the expressions to sort the results by.
DtoOrderByClause<DTO>	orderBy(ExpressionSpec... fields)	Adds an ORDER BY clause to the query, specifying the fields and expressions to sort the results by.
DtoWhereConditionClause<DTO>	where(String field)	Starts a WHERE clause for the SQL query.
DtoWhereConditionClauseTerminal<DTO>	where(QueryConditionBuilder<DTO> query)	Adds a nested condition clause.
DtoWhereConditionClause<DTO>	where(ExpressionSpec expression)	Starts a WHERE clause for the SQL query.
Optional<DTO>	withId(Object id)	Convenience method to select a DTO by its primary key.
@Nullable DTO	withIdOrNull(Object id)	Convenience method to select a DTO by its primary key.
DTO	withIdOrThrow(Object id)	Retrieves a DTO by its primary key and throws an exception if no matching entry is found.
<X extends Throwable> DTO	withIdOrThrow(Object id, Supplier<? extends X> exceptionSupplier)	Retrieves a DTO by its primary key and throws the specified exception if no matching entry is found.

Methods inherited from class org.litebridge.orm.api.select.impl.OrderByClauseTerminalImpl

limit

Methods inherited from class org.litebridge.orm.api.select.impl.LimitClauseTerminalImpl

offset, selectSpec

Methods inherited from class org.litebridge.orm.api.select.impl.DelegatingSelector

first, firstOrNull, firstOrThrow, firstOrThrow, list, one, oneOrNull, oneOrThrow, oneOrThrow, stream, toSql

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.litebridge.orm.api.select.LimitClauseTerminal

offset

Methods inherited from interface org.litebridge.orm.api.select.OrderByClauseTerminal

limit

Methods inherited from interface org.litebridge.orm.api.select.SelectTerminal

first, firstOrNull, firstOrThrow, firstOrThrow, list, one, oneOrNull, oneOrThrow, oneOrThrow, stream, toSql

Constructor Details

DtoFromClauseTerminal

public DtoFromClauseTerminal(DtoSelector<DTO> delegate)

Creates a new DtoFromClauseTerminal.

Parameters:

delegate - the DTO selector delegate

Method Details

where

public DtoWhereConditionClause<DTO> where(String field)

Description copied from interface: JoinClauseTerminal

Starts a WHERE clause for the SQL query.

Adds a filtering condition to the SQL query based on the specified column. This method is part of a fluent API for building SQL queries and transitions to the next stage where additional filtering conditions can be specified.

Specified by:

where in interface JoinClauseTerminal<DTO,DtoJoinClause<DTO>,DtoJoinConditionClause<DTO>,DtoJoinConditionClauseTerminal<DTO>,DtoWhereConditionClause<DTO>,DtoWhereConditionClauseTerminal<DTO>,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>

Parameters:

field - the name of the column to apply the filtering condition on

Returns:

an instance of WCC representing the next stage of the where condition clause

where

public DtoWhereConditionClause<DTO> where(ExpressionSpec expression)

Description copied from interface: JoinClauseTerminal

Starts a WHERE clause for the SQL query.

Adds a filtering condition to the SQL query based on the specified expression.

Specified by:

where in interface JoinClauseTerminal<DTO,DtoJoinClause<DTO>,DtoJoinConditionClause<DTO>,DtoJoinConditionClauseTerminal<DTO>,DtoWhereConditionClause<DTO>,DtoWhereConditionClauseTerminal<DTO>,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>

Parameters:

expression - the expression to apply the filtering condition on

Returns:

an instance of WCC representing the next stage of the where condition clause

where

public DtoWhereConditionClauseTerminal<DTO> where(QueryConditionBuilder<DTO> query)

Adds a nested condition clause.

The nested condition clause is grouped with parentheses to ensure proper SQL syntax.

Parameters:

query - Function that builds the nested condition clause

Returns:

the parent condition clause interface, allowing further chaining of conditions

withId

public Optional<DTO> withId(Object id)

Convenience method to select a DTO by its primary key.

Parameters:

id - the primary key value

Returns:

the selected DTO, if found

withIdOrNull

public @Nullable DTO withIdOrNull(Object id)

Convenience method to select a DTO by its primary key.

Parameters:

id - the primary key value

Returns:

the selected DTO, or null if not found

withIdOrThrow

public DTO withIdOrThrow(Object id)
                  throws NoSuchElementException

Retrieves a DTO by its primary key and throws an exception if no matching entry is found.

Parameters:

id - the primary key value used to identify the DTO

Returns:

the DTO associated with the given primary key

Throws:

NoSuchElementException - if no DTO is found with the specified primary key

withIdOrThrow

public <X extends Throwable> DTO withIdOrThrow(Object id,
 Supplier<? extends X> exceptionSupplier)
                                        throws X

Retrieves a DTO by its primary key and throws the specified exception if no matching entry is found.

Type Parameters:

X - the type of exception to be thrown

Parameters:

id - the primary key value used to identify the DTO

exceptionSupplier - a supplier that provides the exception to be thrown if the DTO is not found

Returns:

the DTO associated with the given primary key

Throws:

X - the exception provided by the supplier if no DTO is found with the specified primary key

join

public DtoJoinClause<DTO> join(Class<?> dtoClass)

Description copied from interface: DtoJoinClassTerminal

Adds a JOIN clause for the specified DTO class.

Specified by:

join in interface DtoJoinClassTerminal<DTO>

Parameters:

dtoClass - the DTO class to join

Returns:

the JOIN clause

groupBy

public DtoGroupByClauseTerminal<DTO> groupBy(String... fields)

Description copied from interface: WhereClauseTerminal

Adds a GROUP BY clause to the query, specifying the column(s) to group the results by.

Specified by:

groupBy in interface WhereClauseTerminal<DTO,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>

Parameters:

fields - the column(s) to group the results by. Each column must be valid for the associated table or view in the query.

Returns:

an instance of the type representing the GROUP BY clause, allowing further specification of ordering or transitioning to the next query stage.

groupBy

public DtoGroupByClauseTerminal<DTO> groupBy(ExpressionSpec... fields)

Description copied from interface: WhereClauseTerminal

Adds a GROUP BY clause to the query, specifying the expressions to group the results by.

Specified by:

groupBy in interface WhereClauseTerminal<DTO,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>

Parameters:

fields - the expressions to group the results by.

Returns:

an instance of the type representing the GROUP BY clause, allowing further specification of ordering or transitioning to the next query stage.

orderBy

public DtoOrderByClause<DTO> orderBy(String... fields)

Description copied from interface: WhereClauseTerminal

Adds an ORDER BY clause to the query, specifying the expressions to sort the results by.

Specified by:

orderBy in interface WhereClauseTerminal<DTO,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>

Parameters:

fields - the expressions that determine the order of the results. Each column must be valid for the associated table or view in the query. The order in which the expressions are specified determines the priority of ordering.

Returns:

an instance of the type representing the ORDER BY clause, allowing further specification of ordering or transitioning to the next query stage.

orderBy

public DtoOrderByClause<DTO> orderBy(ExpressionSpec... fields)

Description copied from interface: WhereClauseTerminal

Adds an ORDER BY clause to the query, specifying the fields and expressions to sort the results by.

Specified by:

orderBy in interface WhereClauseTerminal<DTO,DtoGroupByClauseTerminal<DTO>,DtoHavingConditionClause<DTO>,DtoHavingConditionClauseTerminal<DTO>,DtoOrderByClause<DTO>,DtoOrderByClauseChain<DTO>>

Parameters:

fields - the field and column specifications that determine the order of the results. Each specification includes a mapping of a field to a column. The order in which the specifications are provided defines the priority of ordering.

Returns:

an instance of the type representing the ORDER BY clause, allowing further specification of ordering or transitioning to the next query stage.