com.avaje.ebeaninternal.server.querydefn

Class OrmQueryProperties

java.lang.Object

com.avaje.ebeaninternal.server.querydefn.OrmQueryProperties

All Implemented Interfaces:

Serializable

public class OrmQueryProperties
extends Object
implements Serializable

Represents the Properties of an Object Relational query.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OrmQueryProperties()
OrmQueryProperties(String path) Construct with a given path (null == root path).
OrmQueryProperties(String path, String properties) Used by query language parser.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(OrmQueryProperties child) For secondary queries add a child element.
void	addSecJoinOrderProperty(OrderBy.Property orderProp) Move a OrderBy.Property from the main query to this query join.
void	addSecondaryQueryJoin(String property)
boolean	allProperties()
int	autofetchPlanHash()
void	configureBeanQuery(SpiQuery<?> query) Define the select and joins for this query.
OrmQueryProperties	copy() Creates a copy of the OrmQueryProperties.
<T> SpiExpressionList<T>	filterMany(Query<T> rootQuery) Return the expressions used to filter on this path.
Set<String>	getAllIncludedProperties() Return all the properties including the bean joins.
FetchConfig	getFetchConfig()
SpiExpressionList<?>	getFilterMany() Return the filterMany expression list (can be null).
SpiExpressionList<?>	getFilterManyTrimPath(int trimPath) Return the filterMany expression list (can be null).
int	getLazyFetchBatch()
String	getParentPath()
String	getPath()
String	getProperties()
int	getQueryFetchBatch()
Iterator<String>	getSelectProperties() This excludes the bean joined properties.
boolean	hasProperties() Return true if this has properties.
boolean	hasSelectClause()
void	includeBeanJoin(String propertyName) Add a bean join property.
boolean	isCache()
boolean	isChild(OrmQueryProperties possibleChild)
boolean	isFetchJoin()
boolean	isIncluded(String propName)
boolean	isIncludedBeanJoin(String propertyName) Return true if this property is included as a bean join.
boolean	isLazyFetch()
boolean	isQueryFetch()
boolean	isQueryFetchAll()
boolean	isReadOnly()
void	queryPlanHash(BeanQueryRequest<?> request, HashQueryPlanBuilder builder) Calculate the query plan hash.
void	setDefaultProperties(String properties, Set<String> included) Set the properties from deployment default FetchTypes.
void	setFetchConfig(FetchConfig fetchConfig) Set the Fetch configuration options for this path.
void	setFilterMany(SpiExpressionList<?> filterMany) Set the filterMany expression list.
OrmQueryProperties	setLazyFetchBatch(int lazyFetchBatch) Set the lazy loading batch size.
void	setProperties(String properties) Set the comma delimited properties to fetch for this path.
OrmQueryProperties	setQueryFetch(int batch, boolean queryFetchAll)
OrmQueryProperties	setQueryFetchAll(boolean queryFetchAll)
OrmQueryProperties	setQueryFetchBatch(int queryFetchBatch) Used to convert this join to a query join.
void	setTunedProperties(OrmQueryProperties tunedProperties) Set the properties from a matching autofetch tuned properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OrmQueryProperties

public OrmQueryProperties(String path)

Construct with a given path (null == root path).

OrmQueryProperties

public OrmQueryProperties()

OrmQueryProperties

public OrmQueryProperties(String path,
                  String properties)

Used by query language parser.

Method Detail

addSecJoinOrderProperty

public void addSecJoinOrderProperty(OrderBy.Property orderProp)

Move a OrderBy.Property from the main query to this query join.

setFetchConfig

public void setFetchConfig(FetchConfig fetchConfig)

Set the Fetch configuration options for this path.

getFetchConfig

public FetchConfig getFetchConfig()

setProperties

public void setProperties(String properties)

Set the comma delimited properties to fetch for this path.

This can include the +query and +lazy type hints.

filterMany

public <T> SpiExpressionList<T> filterMany(Query<T> rootQuery)

Return the expressions used to filter on this path. This should be a many path to use this method.

getFilterManyTrimPath

public SpiExpressionList<?> getFilterManyTrimPath(int trimPath)

Return the filterMany expression list (can be null).

getFilterMany

public SpiExpressionList<?> getFilterMany()

Return the filterMany expression list (can be null).

setFilterMany

public void setFilterMany(SpiExpressionList<?> filterMany)

Set the filterMany expression list.

setDefaultProperties

public void setDefaultProperties(String properties,
                        Set<String> included)

Set the properties from deployment default FetchTypes.

setTunedProperties

public void setTunedProperties(OrmQueryProperties tunedProperties)

Set the properties from a matching autofetch tuned properties.

configureBeanQuery

public void configureBeanQuery(SpiQuery<?> query)

Define the select and joins for this query.

copy

public OrmQueryProperties copy()

Creates a copy of the OrmQueryProperties.

hasSelectClause

public boolean hasSelectClause()

toString

public String toString()

Overrides:

toString in class Object

isChild

public boolean isChild(OrmQueryProperties possibleChild)

add

public void add(OrmQueryProperties child)

For secondary queries add a child element.

autofetchPlanHash

public int autofetchPlanHash()

queryPlanHash

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

Calculate the query plan hash.

getProperties

public String getProperties()

hasProperties

public boolean hasProperties()

Return true if this has properties.

isIncludedBeanJoin

public boolean isIncludedBeanJoin(String propertyName)

Return true if this property is included as a bean join.

If a property is included as a bean join then it should not be included as a reference/proxy to avoid duplication.

includeBeanJoin

public void includeBeanJoin(String propertyName)

Add a bean join property.

allProperties

public boolean allProperties()

getSelectProperties

public Iterator<String> getSelectProperties()

This excludes the bean joined properties.

This is because bean joins will have there own node in the SqlTree.

addSecondaryQueryJoin

public void addSecondaryQueryJoin(String property)

getAllIncludedProperties

public Set<String> getAllIncludedProperties()

Return all the properties including the bean joins. This is the set that will be used by EntityBeanIntercept to determine if a property needs to be lazy loaded.

isIncluded

public boolean isIncluded(String propName)

setQueryFetchBatch

public OrmQueryProperties setQueryFetchBatch(int queryFetchBatch)

Used to convert this join to a query join.

Parameters:

queryJoinBatch - where -1 means not a query join and 0 means use the default batch size.

setQueryFetchAll

public OrmQueryProperties setQueryFetchAll(boolean queryFetchAll)

setQueryFetch

public OrmQueryProperties setQueryFetch(int batch,
                               boolean queryFetchAll)

setLazyFetchBatch

public OrmQueryProperties setLazyFetchBatch(int lazyFetchBatch)

Set the lazy loading batch size.

isFetchJoin

public boolean isFetchJoin()

isQueryFetch

public boolean isQueryFetch()

getQueryFetchBatch

public int getQueryFetchBatch()

isQueryFetchAll

public boolean isQueryFetchAll()

isLazyFetch

public boolean isLazyFetch()

getLazyFetchBatch

public int getLazyFetchBatch()

isReadOnly

public boolean isReadOnly()

isCache

public boolean isCache()

getParentPath

public String getParentPath()

getPath

public String getPath()