org.lenskit.data.dao

Class EntityQuery<E extends Entity>

java.lang.Object

org.lenskit.data.dao.EntityQuery<E>

All Implemented Interfaces:

java.util.function.Predicate<Entity>

public class EntityQuery<E extends Entity>
extends java.lang.Object
implements Predicate<Entity>

Representation of a query.

See Also:

newBuilder(EntityType)

Method Summary

Modifier and Type	Method and Description
boolean	apply(Entity entity) Call matches(Entity).
EntityType	getEntityType() Get the entity type to return.
java.util.List<Attribute<?>>	getFilterFields() Get the field filters.
Ordering<Entity>	getOrdering() Get the sort order as an ordering.
java.util.List<SortKey>	getSortKeys() Get the sort keys.
java.lang.Class<E>	getViewType() Get the type to view results as.
boolean	matches(Entity entity) Determine whether this query matches the specified entity.
static EntityQueryBuilder	newBuilder(EntityType type) Construct a new data query builder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Predicate

equals, test

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Method Detail

newBuilder

public static EntityQueryBuilder newBuilder(EntityType type)

Construct a new data query builder.

Parameters:

type - The entity type

Returns:

The query builder.

getEntityType

public EntityType getEntityType()

Get the entity type to return.

Returns:

The type of entities to return.

getFilterFields

public java.util.List<Attribute<?>> getFilterFields()

Get the field filters. The results should only include entities matching all queries.

Returns:

A map of attributes to objects to filter.

getSortKeys

public java.util.List<SortKey> getSortKeys()

Get the sort keys.

Returns:

The list of keys to sort by.

getOrdering

public Ordering<Entity> getOrdering()

Get the sort order as an ordering.

Returns:

An ordering representing the sort order of this query.

getViewType

public java.lang.Class<E> getViewType()

Get the type to view results as.

Returns:

The type to view results as.

apply

public boolean apply(@Nullable
                     Entity entity)

Call matches(Entity).

Parameters:

entity - The entity to match.

Returns:

true if the entity matches the query

matches

public boolean matches(Entity entity)

Determine whether this query matches the specified entity.

Parameters:

entity - The entity to test.

Returns:

The entity.