io.jmix.core

Class FluentValueLoader<T>

java.lang.Object

io.jmix.core.FluentValueLoader<T>

@Component(value="core_FluentValueLoader")
 @Scope(value="prototype")
public class FluentValueLoader<T>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected UnconstrainedDataManager	dataManager

Constructor Summary

Constructors

Constructor and Description
FluentValueLoader(java.lang.String queryString, java.lang.Class<T> valueClass)

Method Summary

Modifier and Type	Method and Description
io.jmix.core.AbstractFluentValueLoader	accessConstraints(java.util.List<AccessConstraint<?>> accessConstraints) Sets access constraints.
protected ValueLoadContext	createLoadContext()
FluentValueLoader<T>	firstResult(int firstResult) Sets results offset.
FluentValueLoader<T>	hint(java.lang.String hintName, java.io.Serializable value) Sets custom hint that should be used by the query.
FluentValueLoader<T>	hints(java.util.Map<java.lang.String,java.io.Serializable> hints) Sets custom hints that should be used by the query.
protected ValueLoadContext	instantiateValueLoadContext()
io.jmix.core.AbstractFluentValueLoader	joinTransaction(boolean join)
java.util.List<T>	list() Loads a list of entities.
FluentValueLoader<T>	maxResults(int maxResults) Sets results limit.
T	one() Loads a single instance.
java.util.Optional<T>	optional() Loads a single instance and wraps it in Optional.
FluentValueLoader<T>	parameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType) Sets value for a parameter of java.util.Date type.
FluentValueLoader<T>	parameter(java.lang.String name, java.lang.Object value) Sets value for a query parameter.
FluentValueLoader<T>	parameter(java.lang.String name, java.lang.Object value, boolean implicitConversion) Sets value for a query parameter.
void	setDataManager(UnconstrainedDataManager dataManager)
FluentValueLoader<T>	setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Sets the map of query parameters.
FluentValueLoader<T>	store(java.lang.String store) Sets DataStore name.

Methods inherited from class java.lang.Object

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

Field Detail

dataManager

protected UnconstrainedDataManager dataManager

Constructor Detail

FluentValueLoader

public FluentValueLoader(java.lang.String queryString,
                         java.lang.Class<T> valueClass)

Method Detail

createLoadContext

protected ValueLoadContext createLoadContext()

list

public java.util.List<T> list()

Loads a list of entities.

optional

public java.util.Optional<T> optional()

Loads a single instance and wraps it in Optional.

one

public T one()

Loads a single instance.

Throws:

java.lang.IllegalStateException - if nothing was loaded

store

public FluentValueLoader<T> store(java.lang.String store)

Sets DataStore name.

hint

public FluentValueLoader<T> hint(java.lang.String hintName,
                                 java.io.Serializable value)

Sets custom hint that should be used by the query.

hints

public FluentValueLoader<T> hints(java.util.Map<java.lang.String,java.io.Serializable> hints)

Sets custom hints that should be used by the query.

parameter

public FluentValueLoader<T> parameter(java.lang.String name,
                                      java.lang.Object value)

Sets value for a query parameter.

Parameters:

name - parameter name

value - parameter value

parameter

public FluentValueLoader<T> parameter(java.lang.String name,
                                      java.util.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

parameter

public FluentValueLoader<T> parameter(java.lang.String name,
                                      java.lang.Object value,
                                      boolean implicitConversion)

Sets value for a query parameter.

Parameters:

name - parameter name

value - parameter value

implicitConversion - whether to do parameter value conversions, e.g. convert an entity to its ID

setParameters

public FluentValueLoader<T> setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Sets the map of query parameters.

firstResult

public FluentValueLoader<T> firstResult(int firstResult)

Sets results offset.

maxResults

public FluentValueLoader<T> maxResults(int maxResults)

Sets results limit.

setDataManager

public void setDataManager(UnconstrainedDataManager dataManager)

joinTransaction

public io.jmix.core.AbstractFluentValueLoader joinTransaction(boolean join)

accessConstraints

public io.jmix.core.AbstractFluentValueLoader accessConstraints(java.util.List<AccessConstraint<?>> accessConstraints)

Sets access constraints.

instantiateValueLoadContext

protected ValueLoadContext instantiateValueLoadContext()