com.breeze.query

Class EntityQuery

java.lang.Object

com.breeze.query.EntityQuery

public class EntityQuery
extends java.lang.Object

Represents a query against a strongly typed model. This query is designed to be easily converted into variety of persistence library query languages via subclasses of the QueryProcessor class. An EntityQuery is an immutable structure. This means that mutation methods on an EntityQuery actually all return new EntityQuery instances.

Author:

IdeaBlade

Constructor Summary

Constructors

Constructor and Description
EntityQuery()
EntityQuery(EntityQuery query) Copy constructor
EntityQuery(java.lang.String json) Materializes the serialized json representation of an EntityQuery.

Method Summary

Methods

Modifier and Type	Method and Description
EntityQuery	enableInlineCount(boolean inlineCountEnabled) Return a new query based on this query that either adds or removes the inline count capability.
EntityQuery	expand(java.util.List<java.lang.String> propertyPaths) Return a new query based on this query with the specified expand clauses added.
EntityQuery	expand(java.lang.String... propertyPaths) Return a new query based on this query with the specified expand clauses added.
IEntityType	getEntityType() Returns the EntityType that this query has been validated against.
ExpandClause	getExpandClause()
OrderByClause	getOrderByClause()
java.util.Map	getParameters()
java.lang.String	getResourceName()
SelectClause	getSelectClause()
java.lang.Integer	getSkipCount()
java.lang.Integer	getTakeCount()
Predicate	getWherePredicate()
boolean	isInlineCountEnabled()
EntityQuery	orderBy(java.util.List<java.lang.String> propertyPaths) Return a new query based on this query with the specified orderBy clauses added.
EntityQuery	orderBy(java.lang.String... propertyPaths) Return a new query based on this query with the specified orderBy clauses added.
EntityQuery	select(java.util.List<java.lang.String> propertyPaths) Return a new query based on this query with the specified select (projection) clauses added.
EntityQuery	select(java.lang.String... propertyPaths) Return a new query based on this query with the specified select (projection) clauses added.
EntityQuery	skip(java.lang.Integer skipCount) Return a new query based on this query that skips the first n records.
EntityQuery	take(java.lang.Integer takeCount) Return a new query based on this query that limits the results to the first n records.
void	validate(IEntityType entityType) Validates that all of the clauses that make up this query are consistent with the specified EntityType.
EntityQuery	where(Predicate predicate) Return a new query based on this query with an additional where clause added.
EntityQuery	where(java.lang.String json) Return a new query based on this query with an additional where clause added.
EntityQuery	withResourceName(java.lang.String resourceName) Return a new query based on this query with the specified resourceName

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityQuery

public EntityQuery()

EntityQuery

public EntityQuery(java.lang.String json)

Materializes the serialized json representation of an EntityQuery.

Parameters:

json - The serialized json version of the EntityQuery.

EntityQuery

public EntityQuery(EntityQuery query)

Copy constructor

Parameters:

query -

Method Detail

where

public EntityQuery where(java.lang.String json)

Return a new query based on this query with an additional where clause added.

Parameters:

json - Json representation of the where clause.

Returns:

A new EntityQuery.

where

public EntityQuery where(Predicate predicate)

Return a new query based on this query with an additional where clause added.

Parameters:

predicate - A Predicate representing the where clause to add.

Returns:

A new EntityQuery.

orderBy

public EntityQuery orderBy(java.lang.String... propertyPaths)

Return a new query based on this query with the specified orderBy clauses added.

Parameters:

propertyPaths - A varargs array of orderBy clauses ( each consisting of a property path and an optional sort direction).

Returns:

A new EntityQuery.

orderBy

public EntityQuery orderBy(java.util.List<java.lang.String> propertyPaths)

Return a new query based on this query with the specified orderBy clauses added.

Parameters:

propertyPaths - An List of orderBy clauses ( each consisting of a property path and an optional sort direction).

Returns:

A new EntityQuery.

expand

public EntityQuery expand(java.lang.String... propertyPaths)

Return a new query based on this query with the specified expand clauses added.

Parameters:

propertyPaths - A varargs array of expand clauses ( each a dot delimited property path).

Returns:

A new EntityQuery.

expand

public EntityQuery expand(java.util.List<java.lang.String> propertyPaths)

Return a new query based on this query with the specified expand clauses added.

Parameters:

propertyPaths - A list of expand clauses (each a dot delimited property path).

Returns:

A new EntityQuery.

select

public EntityQuery select(java.lang.String... propertyPaths)

Return a new query based on this query with the specified select (projection) clauses added.

Parameters:

propertyPaths - A varargs array of select clauses (each a dot delimited property path).

Returns:

A new EntityQuery.

select

public EntityQuery select(java.util.List<java.lang.String> propertyPaths)

Return a new query based on this query with the specified select (projection) clauses added.

Parameters:

propertyPaths - A list of select clauses (each a dot delimited property path).

Returns:

A new EntityQuery.

take

public EntityQuery take(java.lang.Integer takeCount)

Return a new query based on this query that limits the results to the first n records.

Parameters:

takeCount - The number of records to take.

Returns:

A new EntityQuery

skip

public EntityQuery skip(java.lang.Integer skipCount)

Return a new query based on this query that skips the first n records.

Parameters:

skipCount - The number of records to skip.

Returns:

A new EntityQuery

enableInlineCount

public EntityQuery enableInlineCount(boolean inlineCountEnabled)

Return a new query based on this query that either adds or removes the inline count capability.

Parameters:

inlineCountEnabled - Whether to enable inlineCount.

Returns:

A new EntityQuery

withResourceName

public EntityQuery withResourceName(java.lang.String resourceName)

Return a new query based on this query with the specified resourceName

Parameters:

resourceName - The name of the url resource.

Returns:

A new EntityQuery

validate

public void validate(IEntityType entityType)

Validates that all of the clauses that make up this query are consistent with the specified EntityType.

Parameters:

entityType - A EntityType

getEntityType

public IEntityType getEntityType()

Returns the EntityType that this query has been validated against. Not that this property will return null until the validate method has been called.

Returns:

The EntityType that this query has been validated against.

getResourceName

public java.lang.String getResourceName()

getWherePredicate

public Predicate getWherePredicate()

getOrderByClause

public OrderByClause getOrderByClause()

getExpandClause

public ExpandClause getExpandClause()

getSelectClause

public SelectClause getSelectClause()

getSkipCount

public java.lang.Integer getSkipCount()

getTakeCount

public java.lang.Integer getTakeCount()

isInlineCountEnabled

public boolean isInlineCountEnabled()

getParameters

public java.util.Map getParameters()