org.lenskit.data.dao

Class EntityQueryBuilder

java.lang.Object

org.lenskit.data.dao.EntityQueryBuilder

public class EntityQueryBuilder
extends Object

Data query builder exposing a fluent interface.

Constructor Summary

Constructors

Constructor and Description
EntityQueryBuilder(EntityType type) Construct a new data query builder.

Method Summary

Modifier and Type	Method and Description
<A> EntityQueryBuilder	addFilterField(Attribute<?> condition) Add a filter condition to the builder.
<A> EntityQueryBuilder	addFilterField(TypedName<A> name, A obj) Add a filter condition to the builder.
EntityQueryBuilder	addFilterFields(List<Attribute<?>> conditions) Add a filter condition to the builder.
EntityQueryBuilder	addSortKey(SortKey key) Add a sort key.
EntityQueryBuilder	addSortKey(TypedName<? extends Comparable> attr) Add an ascending sort key.
EntityQueryBuilder	addSortKey(TypedName<? extends Comparable> name, SortOrder order) Add a sort key.
EntityQueryBuilder	addSortKeys(Iterable<SortKey> keys) Add multiple sort keys.
EntityQuery<Entity>	build() Build the data query.
<E extends Entity> EntityQuery<E>	buildWithView(Class<E> viewClass) Build the data query with a view type.
EntityQueryBuilder	copy() Create a new entity query builder that is a copy of this one.
EntityQueryBuilder	setEntityType(EntityType type) Deprecated. Just provide a type at construction time.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityQueryBuilder

public EntityQueryBuilder(EntityType type)

Construct a new data query builder.

Parameters:

type - The entity type.

Method Detail

setEntityType

@Deprecated
public EntityQueryBuilder setEntityType(EntityType type)

Deprecated. Just provide a type at construction time.

Set the entity type.

Parameters:

type - The entity type.

Returns:

The query builder (for chaining).

addFilterField

public <A> EntityQueryBuilder addFilterField(TypedName<A> name,
                                             @Nonnull
                                             A obj)

Add a filter condition to the builder.

Parameters:

name - The attribute to filter.

obj - The object to test for equality.

A - The attribute type.

Returns:

The query builder (for chaining).

addFilterField

public <A> EntityQueryBuilder addFilterField(Attribute<?> condition)

Add a filter condition to the builder.

Parameters:

condition - The condition to add.

A - The attribute type.

Returns:

The query builder (for chaining).

addFilterFields

public EntityQueryBuilder addFilterFields(List<Attribute<?>> conditions)

Add a filter condition to the builder.

Parameters:

conditions - The conditions to add.

Returns:

The query builder (for chaining).

addSortKey

public EntityQueryBuilder addSortKey(TypedName<? extends Comparable> attr)

Add an ascending sort key.

Parameters:

attr - The attribute to sort by.

Returns:

The query builder (for chaining).

addSortKey

public EntityQueryBuilder addSortKey(TypedName<? extends Comparable> name,
                                     SortOrder order)

Add a sort key.

Parameters:

name - The attribute to sort by.

order - The sort order.

Returns:

The query builder (for chaining).

addSortKey

public EntityQueryBuilder addSortKey(SortKey key)

Add a sort key.

Parameters:

key - The sort key to add.

Returns:

The query builder (for chaining).

addSortKeys

public EntityQueryBuilder addSortKeys(Iterable<SortKey> keys)

Add multiple sort keys.

Parameters:

keys - The sort key to add.

Returns:

The query builder (for chaining).

copy

public EntityQueryBuilder copy()

Create a new entity query builder that is a copy of this one. Future additions to either will not affect the other.

Returns:

A new query builder.

build

public EntityQuery<Entity> build()

Build the data query.

Returns:

The data query.

buildWithView

public <E extends Entity> EntityQuery<E> buildWithView(Class<E> viewClass)

Build the data query with a view type.

Returns:

The data query.