Package io.jmix.core

Class FluentLoader.ByCondition<E>

java.lang.Object

io.jmix.core.FluentLoader.ByCondition<E>

Enclosing class:

FluentLoader<E>

public static class FluentLoader.ByCondition<E>
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ByCondition(FluentLoader.ByQuery<E> byQuery, Condition condition)
protected	ByCondition(FluentLoader<E> loader, String entityName, Condition condition)

Method Summary

Modifier and Type	Method	Description
FluentLoader.ByCondition<E>	accessConstraints(Class<? extends AccessConstraint> accessConstraintsClass)	Adds registered access constraints that are subclasses of the given class.
FluentLoader.ByCondition<E>	accessConstraints(Collection<AccessConstraint<?>> accessConstraints)	Adds access constraints.
FluentLoader.ByCondition<E>	cacheable(boolean cacheable)	Indicates that the query results should be cached.
FluentLoader.ByCondition<E>	fetchPlan(FetchPlan fetchPlan)	Sets a fetch plan.
FluentLoader.ByCondition<E>	fetchPlan(String fetchPlanName)	Sets a fetchPlan by name.
FluentLoader.ByCondition<E>	fetchPlan(Consumer<FetchPlanBuilder> fetchPlanBuilderConfigurer)	Configure the fetch plan.
FluentLoader.ByCondition<E>	fetchPlanProperties(String... properties)	Sets a fetch plan containing the given properties.
FluentLoader.ByCondition<E>	firstResult(int firstResult)	Sets results offset.
FluentLoader.ByCondition<E>	hint(String hintName, Serializable value)	Adds custom hint that should be used by the query.
FluentLoader.ByCondition<E>	hints(Map<String,Serializable> hints)	Adds custom hints that should be used by the query.
FluentLoader.ByCondition<E>	joinTransaction(boolean join)	Indicates that the operation must be performed in an existing transaction if it exists.
List<E>	list()	Loads a list of entities.
FluentLoader.ByCondition<E>	maxResults(int maxResults)	Sets results limit.
E	one()	Loads a single instance.
Optional<E>	optional()	Loads a single instance and wraps it in Optional.
FluentLoader.ByCondition<E>	parameter(String name, Object value)	Sets value for a query parameter.
FluentLoader.ByCondition<E>	parameter(String name, Date value, javax.persistence.TemporalType temporalType)	Sets value for a parameter of java.util.Date type.
FluentLoader.ByCondition<E>	parameters(Map<String,Object> parameters)	Adds the given parameters to the map of query parameters.
FluentLoader.ByCondition<E>	sort(Sort sort)	Sets sorting, for example sort(Sort.by("name"))

Methods inherited from class java.lang.Object

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

Constructor Details

ByCondition

protected ByCondition(FluentLoader<E> loader,
 String entityName,
 Condition condition)

ByCondition

protected ByCondition(FluentLoader.ByQuery<E> byQuery,
 Condition condition)

Method Details

list

public List<E> list()

Loads a list of entities.

optional

public Optional<E> optional()

Loads a single instance and wraps it in Optional.

one

public E one()

Loads a single instance.

Throws:

IllegalStateException - if nothing was loaded

fetchPlan

public FluentLoader.ByCondition<E> fetchPlan(@Nullable
 FetchPlan fetchPlan)

Sets a fetch plan.

fetchPlan

public FluentLoader.ByCondition<E> fetchPlan(@Nullable
 String fetchPlanName)

Sets a fetchPlan by name.

fetchPlan

public FluentLoader.ByCondition<E> fetchPlan(Consumer<FetchPlanBuilder> fetchPlanBuilderConfigurer)

Configure the fetch plan.

fetchPlanProperties

public FluentLoader.ByCondition<E> fetchPlanProperties(String... properties)

Sets a fetch plan containing the given properties. A property can be designated by a path in the entity graph. For example:

     dataManager.load(Pet.class)
         .condition(...)
         .fetchPlanProperties(
                 "name",
                 "owner.name",
                 "owner.address.city")
         .list();
 

hint

public FluentLoader.ByCondition<E> hint(String hintName,
 Serializable value)

Adds custom hint that should be used by the query.

hints

public FluentLoader.ByCondition<E> hints(Map<String,Serializable> hints)

Adds custom hints that should be used by the query.

parameter

public FluentLoader.ByCondition<E> parameter(String name,
 Object value)

Sets value for a query parameter.

Parameters:

name - parameter name

value - parameter value

parameter

public FluentLoader.ByCondition<E> parameter(String name,
 Date value,
 javax.persistence.TemporalType temporalType)

Sets value for a parameter of java.util.Date type.

Parameters:

name - parameter name

value - parameter value

temporalType - how to interpret the value

parameters

public FluentLoader.ByCondition<E> parameters(Map<String,Object> parameters)

Adds the given parameters to the map of query parameters.

firstResult

public FluentLoader.ByCondition<E> firstResult(int firstResult)

Sets results offset.

maxResults

public FluentLoader.ByCondition<E> maxResults(int maxResults)

Sets results limit.

sort

public FluentLoader.ByCondition<E> sort(Sort sort)

Sets sorting, for example sort(Sort.by("name"))

cacheable

public FluentLoader.ByCondition<E> cacheable(boolean cacheable)

Indicates that the query results should be cached. By default, queries are not cached.

accessConstraints

public FluentLoader.ByCondition<E> accessConstraints(Collection<AccessConstraint<?>> accessConstraints)

Adds access constraints.

accessConstraints

public FluentLoader.ByCondition<E> accessConstraints(Class<? extends AccessConstraint> accessConstraintsClass)

Adds registered access constraints that are subclasses of the given class.

joinTransaction

public FluentLoader.ByCondition<E> joinTransaction(boolean join)

Indicates that the operation must be performed in an existing transaction if it exists. True by default.