Module io.ebean.core

Package io.ebeaninternal.api

Interface SpiDtoQuery<T>

All Superinterfaces:

CancelableQuery, DtoQuery<T>, SpiCancelableQuery, SpiSqlBinding

All Known Implementing Classes:

DefaultDtoQuery

public interface SpiDtoQuery<T>
extends DtoQuery<T>, SpiSqlBinding

Internal extension to DtoQuery.

Method Summary

Modifier and Type	Method	Description
io.ebeaninternal.server.dto.DtoQueryPlan	buildPlan(io.ebeaninternal.server.dto.DtoMappingRequest request)	Build the query plan.
boolean	isRelaxedMode()	Return true if the query is in relaxed mapping mode.
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.
Class<T>	type()	Return the associated DTO bean type.

Methods inherited from interface io.ebean.CancelableQuery

cancel

Methods inherited from interface io.ebean.DtoQuery

findEach, findEach, findEachWhile, findIterate, findList, findOne, findOneOrEmpty, findStream, setArrayParameter, setBufferFetchSizeHint, setFirstRow, setLabel, setMaxRows, setNullParameter, setNullParameter, setParameter, setParameter, setParameter, setParameters, setProfileLocation, setRelaxedMode, setTimeout, usingConnection, usingMaster, usingTransaction

Methods inherited from interface io.ebeaninternal.api.SpiCancelableQuery

checkCancelled, setCancelableQuery

Methods inherited from interface io.ebeaninternal.api.SpiSqlBinding

getBindParams, getBufferFetchSizeHint, getFirstRow, getLabel, getMaxRows, getQuery, getTimeout, isUseMaster, setDefaultFetchBuffer, transaction

Method Details

planKey

String planKey()

Return the key for query plan.

queryPlan

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

Get the query plan for the cache.

buildPlan

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

Build the query plan.

putQueryPlan

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

Put the query plan into the cache.

isRelaxedMode

boolean isRelaxedMode()

Return true if the query is in relaxed mapping mode.

planLabel

String planLabel()

Return the label with fallback to profile location label.

obtainLocation

void obtainLocation()

Obtain the location if necessary.

profileLocation

ProfileLocation profileLocation()

Return the profile location.

type

Class<T> type()

Return the associated DTO bean type.

ormQuery

SpiQuery<?> ormQuery()

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