com.avaje.ebeaninternal.server.querydefn

Class OrmQueryDetail

java.lang.Object

com.avaje.ebeaninternal.server.querydefn.OrmQueryDetail

All Implemented Interfaces:

Serializable

public class OrmQueryDetail
extends Object
implements Serializable

Represents the internal structure of an Object Relational query.

Holds the select() and join() details of a ORM query.

It is worth noting that for autoFetch a "tuned fetch info" builds an instance of OrmQueryDetail. Tuning a query is a matter of replacing an instance of this class with one that has been tuned with select() and join() set.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OrmQueryDetail()

Method Summary

Methods

Modifier and Type	Method and Description
OrmQueryProperties	addFetch(String path, String partialProps, FetchConfig fetchConfig) Set the fetch properties and configuration for a given path.
void	clear() Remove all joins and properties.
boolean	containsProperty(String property)
void	convertManyFetchJoinsToQueryJoins(BeanDescriptor<?> beanDescriptor, String lazyLoadManyPath, boolean allowOne, int queryBatch) Convert 'fetch joins' to 'many' properties over to 'query joins'.
OrmQueryDetail	copy() Return a deep copy of the OrmQueryDetail.
OrmQueryProperties	getChunk(String path, boolean create)
HashSet<String>	getIncludes() Return the property includes for this detail.
int	hashCode()
boolean	hasSelectClause()
void	includeBeanJoin(String parentPath, String propertyName) Add the explicit bean join.
boolean	includes(String path) Return true if the property is included.
boolean	isAutoFetchEqual(OrmQueryDetail otherDetail) Return true if equal in terms of autofetch (select and joins).
boolean	isEmpty() Return true if the query detail has neither select properties specified or any joins defined.
boolean	isJoinsEmpty() Return true if there are no joins.
void	putFetchPath(OrmQueryProperties chunk) Matches a join() method of the query.
void	queryPlanHash(BeanQueryRequest<?> request, HashQueryPlanBuilder builder) Calculate the hash for the query plan.
List<OrmQueryProperties>	removeSecondaryLazyQueries()
List<OrmQueryProperties>	removeSecondaryQueries()
void	select(String columns) set the properties to include on the base / root entity.
void	setBase(OrmQueryProperties baseProps) Set the base / root query properties.
void	setDefaultSelectClause(BeanDescriptor<?> desc) Set any default select clauses for the main bean and any joins that have not explicitly defined a select clause.
void	sortFetchPaths(BeanDescriptor<?> d)
String	toString()
boolean	tuneFetchProperties(OrmQueryDetail tunedDetail)

Methods inherited from class java.lang.Object

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

Constructor Detail

OrmQueryDetail

public OrmQueryDetail()

Method Detail

copy

public OrmQueryDetail copy()

Return a deep copy of the OrmQueryDetail.

queryPlanHash

public void queryPlanHash(BeanQueryRequest<?> request,
                 HashQueryPlanBuilder builder)

Calculate the hash for the query plan.

isAutoFetchEqual

public boolean isAutoFetchEqual(OrmQueryDetail otherDetail)

Return true if equal in terms of autofetch (select and joins).

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

select

public void select(String columns)

set the properties to include on the base / root entity.

containsProperty

public boolean containsProperty(String property)

setBase

public void setBase(OrmQueryProperties baseProps)

Set the base / root query properties.

removeSecondaryQueries

public List<OrmQueryProperties> removeSecondaryQueries()

removeSecondaryLazyQueries

public List<OrmQueryProperties> removeSecondaryLazyQueries()

tuneFetchProperties

public boolean tuneFetchProperties(OrmQueryDetail tunedDetail)

putFetchPath

public void putFetchPath(OrmQueryProperties chunk)

Matches a join() method of the query.

clear

public void clear()

Remove all joins and properties.

Typically for the row count query.

addFetch

public OrmQueryProperties addFetch(String path,
                          String partialProps,
                          FetchConfig fetchConfig)

Set the fetch properties and configuration for a given path.

Parameters:

path - the property to join

partialProps - the properties on the join property to include

sortFetchPaths

public void sortFetchPaths(BeanDescriptor<?> d)

convertManyFetchJoinsToQueryJoins

public void convertManyFetchJoinsToQueryJoins(BeanDescriptor<?> beanDescriptor,
                                     String lazyLoadManyPath,
                                     boolean allowOne,
                                     int queryBatch)

Convert 'fetch joins' to 'many' properties over to 'query joins'.

setDefaultSelectClause

public void setDefaultSelectClause(BeanDescriptor<?> desc)

Set any default select clauses for the main bean and any joins that have not explicitly defined a select clause.

That is this will use FetchType.LAZY to exclude some properties by default.

hasSelectClause

public boolean hasSelectClause()

isEmpty

public boolean isEmpty()

Return true if the query detail has neither select properties specified or any joins defined.

isJoinsEmpty

public boolean isJoinsEmpty()

Return true if there are no joins.

includeBeanJoin

public void includeBeanJoin(String parentPath,
                   String propertyName)

Add the explicit bean join.

This is also used to Exclude the matching property from the parent select (aka remove the foreign key) because it is now included in it's on node in the SqlTree.

getChunk

public OrmQueryProperties getChunk(String path,
                          boolean create)

includes

public boolean includes(String path)

Return true if the property is included.

getIncludes

public HashSet<String> getIncludes()

Return the property includes for this detail.