Module io.ebean.core

Package io.ebeaninternal.server.querydefn

Class DefaultDtoQuery<T>

java.lang.Object

io.ebeaninternal.server.querydefn.AbstractQuery

io.ebeaninternal.server.querydefn.DefaultDtoQuery<T>

All Implemented Interfaces:

CancelableQuery, DtoQuery<T>, SpiCancelableQuery, SpiDtoQuery<T>, SpiSqlBinding

@NonNullApi
public final class DefaultDtoQuery<T>
extends AbstractQuery
implements SpiDtoQuery<T>

Default implementation of DtoQuery.

Field Summary

Fields inherited from class io.ebeaninternal.server.querydefn.AbstractQuery

useMaster

Constructor Summary

Constructors

Constructor	Description
DefaultDtoQuery(SpiEbeanServer server, io.ebeaninternal.server.dto.DtoBeanDescriptor<T> descriptor, SpiQuery<?> ormQuery)	Create given an underlying ORM query.
DefaultDtoQuery(SpiEbeanServer server, io.ebeaninternal.server.dto.DtoBeanDescriptor<T> descriptor, String sql)	Create given a native SQL query.

Method Summary

Modifier and Type	Method	Description
io.ebeaninternal.server.dto.DtoQueryPlan	buildPlan(io.ebeaninternal.server.dto.DtoMappingRequest request)	Build the query plan.
void	findEach(int batch, Consumer<List<T>> consumer)
void	findEach(Consumer<T> consumer)
void	findEachWhile(Predicate<T> consumer)
QueryIterator<T>	findIterate()
List<T>	findList()
T	findOne()
Optional<T>	findOneOrEmpty()
Stream<T>	findStream()
BindParams	getBindParams()	Return the named or positioned parameters.
int	getBufferFetchSizeHint()	Return the hint for Statement.setFetchSize().
int	getFirstRow()	Return the first row to fetch.
String	getLabel()	Return the label (to collect metrics on when set).
int	getMaxRows()	Return the maximum number of rows to fetch.
String	getQuery()	return the query.
int	getTimeout()	Return the query timeout.
boolean	isRelaxedMode()	Return true if the query is in relaxed mapping mode.
boolean	isUseMaster()	Return true if this query should not use the read only data source.
void	obtainLocation()	Obtain the location if necessary.
SpiQuery<?>	ormQuery()	Return an underlying ORM query (if this query is built from an ORM query).
String	planKey()	Return the key for query plan.
String	planLabel()	Return the label with fallback to profile location label.
ProfileLocation	profileLocation()	Return the profile location.
void	putQueryPlan(Object planKey, io.ebeaninternal.server.dto.DtoQueryPlan plan)	Put the query plan into the cache.
io.ebeaninternal.server.dto.DtoQueryPlan	queryPlan(Object planKey)	Get the query plan for the cache.
DtoQuery<T>	setArrayParameter(String paramName, Collection<?> values)
DtoQuery<T>	setBufferFetchSizeHint(int bufferFetchSizeHint)
DtoQuery<T>	setFirstRow(int firstRow)
DtoQuery<T>	setLabel(String label)
DtoQuery<T>	setMaxRows(int maxRows)
DtoQuery<T>	setNullParameter(int position, int jdbcType)
DtoQuery<T>	setNullParameter(String name, int jdbcType)
DtoQuery<T>	setParameter(int position, Object value)
DtoQuery<T>	setParameter(Object value)
DtoQuery<T>	setParameter(String paramName, Object value)
DtoQuery<T>	setParameters(Object... values)
DtoQuery<T>	setProfileLocation(ProfileLocation profileLocation)
DtoQuery<T>	setRelaxedMode()
DtoQuery<T>	setTimeout(int secs)
String	toString()
SpiTransaction	transaction()	Return the transaction explicitly associated to the query.
Class<T>	type()	Return the associated DTO bean type.
DtoQuery<T>	usingConnection(Connection connection)
DtoQuery<T>	usingMaster()
DtoQuery<T>	usingTransaction(Transaction transaction)

Methods inherited from class io.ebeaninternal.server.querydefn.AbstractQuery

cancel, checkCancelled, setCancelableQuery

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ebean.CancelableQuery

cancel

Methods inherited from interface io.ebeaninternal.api.SpiCancelableQuery

checkCancelled, setCancelableQuery

Constructor Details

DefaultDtoQuery

public DefaultDtoQuery(SpiEbeanServer server,
 io.ebeaninternal.server.dto.DtoBeanDescriptor<T> descriptor,
 SpiQuery<?> ormQuery)

Create given an underlying ORM query.

DefaultDtoQuery

public DefaultDtoQuery(SpiEbeanServer server,
 io.ebeaninternal.server.dto.DtoBeanDescriptor<T> descriptor,
 String sql)

Create given a native SQL query.

Method Details

planKey

public String planKey()

Description copied from interface: SpiDtoQuery

Return the key for query plan.

Specified by:

planKey in interface SpiDtoQuery<T>

queryPlan

public io.ebeaninternal.server.dto.DtoQueryPlan queryPlan(Object planKey)

Description copied from interface: SpiDtoQuery

Get the query plan for the cache.

Specified by:

queryPlan in interface SpiDtoQuery<T>

buildPlan

public io.ebeaninternal.server.dto.DtoQueryPlan buildPlan(io.ebeaninternal.server.dto.DtoMappingRequest request)

Description copied from interface: SpiDtoQuery

Build the query plan.

Specified by:

buildPlan in interface SpiDtoQuery<T>

putQueryPlan

public void putQueryPlan(Object planKey,
 io.ebeaninternal.server.dto.DtoQueryPlan plan)

Description copied from interface: SpiDtoQuery

Put the query plan into the cache.

Specified by:

putQueryPlan in interface SpiDtoQuery<T>

usingTransaction

public DtoQuery<T> usingTransaction(Transaction transaction)

Specified by:

usingTransaction in interface DtoQuery<T>

usingConnection

public DtoQuery<T> usingConnection(Connection connection)

Specified by:

usingConnection in interface DtoQuery<T>

usingMaster

public DtoQuery<T> usingMaster()

Specified by:

usingMaster in interface DtoQuery<T>

isUseMaster

public boolean isUseMaster()

Description copied from interface: SpiSqlBinding

Return true if this query should not use the read only data source.

Specified by:

isUseMaster in interface SpiSqlBinding

findEach

public void findEach(Consumer<T> consumer)

Specified by:

findEach in interface DtoQuery<T>

findEach

public void findEach(int batch,
 Consumer<List<T>> consumer)

Specified by:

findEach in interface DtoQuery<T>

findEachWhile

public void findEachWhile(Predicate<T> consumer)

Specified by:

findEachWhile in interface DtoQuery<T>

findIterate

public QueryIterator<T> findIterate()

Specified by:

findIterate in interface DtoQuery<T>

findStream

public Stream<T> findStream()

Specified by:

findStream in interface DtoQuery<T>

findList

public List<T> findList()

Specified by:

findList in interface DtoQuery<T>

findOne

@Nullable
public T findOne()

Specified by:

findOne in interface DtoQuery<T>

findOneOrEmpty

public Optional<T> findOneOrEmpty()

Specified by:

findOneOrEmpty in interface DtoQuery<T>

setNullParameter

public DtoQuery<T> setNullParameter(String name,
 int jdbcType)

Specified by:

setNullParameter in interface DtoQuery<T>

setNullParameter

public DtoQuery<T> setNullParameter(int position,
 int jdbcType)

Specified by:

setNullParameter in interface DtoQuery<T>

setParameter

public DtoQuery<T> setParameter(int position,
 Object value)

Specified by:

setParameter in interface DtoQuery<T>

setParameter

public DtoQuery<T> setParameter(String paramName,
 Object value)

Specified by:

setParameter in interface DtoQuery<T>

setArrayParameter

public DtoQuery<T> setArrayParameter(String paramName,
 Collection<?> values)

Specified by:

setArrayParameter in interface DtoQuery<T>

setParameters

public DtoQuery<T> setParameters(Object... values)

Specified by:

setParameters in interface DtoQuery<T>

setParameter

public DtoQuery<T> setParameter(Object value)

Specified by:

setParameter in interface DtoQuery<T>

toString

public String toString()

Overrides:

toString in class Object

type

public Class<T> type()

Description copied from interface: SpiDtoQuery

Return the associated DTO bean type.

Specified by:

type in interface SpiDtoQuery<T>

ormQuery

public SpiQuery<?> ormQuery()

Description copied from interface: SpiDtoQuery

Return an underlying ORM query (if this query is built from an ORM query).

Specified by:

ormQuery in interface SpiDtoQuery<T>

transaction

public SpiTransaction transaction()

Description copied from interface: SpiSqlBinding

Return the transaction explicitly associated to the query.

Specified by:

transaction in interface SpiSqlBinding

setRelaxedMode

public DtoQuery<T> setRelaxedMode()

Specified by:

setRelaxedMode in interface DtoQuery<T>

isRelaxedMode

public boolean isRelaxedMode()

Description copied from interface: SpiDtoQuery

Return true if the query is in relaxed mapping mode.

Specified by:

isRelaxedMode in interface SpiDtoQuery<T>

setLabel

public DtoQuery<T> setLabel(String label)

Specified by:

setLabel in interface DtoQuery<T>

getLabel

public String getLabel()

Description copied from interface: SpiSqlBinding

Return the label (to collect metrics on when set).

Specified by:

getLabel in interface SpiSqlBinding

planLabel

@Nullable
public String planLabel()

Description copied from interface: SpiDtoQuery

Return the label with fallback to profile location label.

Specified by:

planLabel in interface SpiDtoQuery<T>

obtainLocation

public void obtainLocation()

Description copied from interface: SpiDtoQuery

Obtain the location if necessary.

Specified by:

obtainLocation in interface SpiDtoQuery<T>

setProfileLocation

public DtoQuery<T> setProfileLocation(ProfileLocation profileLocation)

Specified by:

setProfileLocation in interface DtoQuery<T>

profileLocation

public ProfileLocation profileLocation()

Description copied from interface: SpiDtoQuery

Return the profile location.

Specified by:

profileLocation in interface SpiDtoQuery<T>

getFirstRow

public int getFirstRow()

Description copied from interface: SpiSqlBinding

Return the first row to fetch.

Specified by:

getFirstRow in interface SpiSqlBinding

setFirstRow

public DtoQuery<T> setFirstRow(int firstRow)

Specified by:

setFirstRow in interface DtoQuery<T>

getMaxRows

public int getMaxRows()

Description copied from interface: SpiSqlBinding

Return the maximum number of rows to fetch.

Specified by:

getMaxRows in interface SpiSqlBinding

setMaxRows

public DtoQuery<T> setMaxRows(int maxRows)

Specified by:

setMaxRows in interface DtoQuery<T>

getTimeout

public int getTimeout()

Description copied from interface: SpiSqlBinding

Return the query timeout.

Specified by:

getTimeout in interface SpiSqlBinding

setTimeout

public DtoQuery<T> setTimeout(int secs)

Specified by:

setTimeout in interface DtoQuery<T>

getBindParams

public BindParams getBindParams()

Description copied from interface: SpiSqlBinding

Return the named or positioned parameters.

Specified by:

getBindParams in interface SpiSqlBinding

setBufferFetchSizeHint

public DtoQuery<T> setBufferFetchSizeHint(int bufferFetchSizeHint)

Specified by:

setBufferFetchSizeHint in interface DtoQuery<T>

getBufferFetchSizeHint

public int getBufferFetchSizeHint()

Description copied from interface: SpiSqlBinding

Return the hint for Statement.setFetchSize().

Specified by:

getBufferFetchSizeHint in interface SpiSqlBinding

getQuery

public String getQuery()

Description copied from interface: SpiSqlBinding

return the query.

Specified by:

getQuery in interface SpiSqlBinding