io.jmix.core

Class FluentValuesLoader

java.lang.Object

io.jmix.core.FluentValuesLoader

@Component(value="core_FluentValuesLoader")
 @Scope(value="prototype")
public class FluentValuesLoader
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected UnconstrainedDataManager	dataManager

Constructor Summary

Constructors

Constructor and Description
FluentValuesLoader(java.lang.String queryString)

Method Summary

Modifier and Type	Method and Description
io.jmix.core.AbstractFluentValueLoader	accessConstraints(java.util.List<AccessConstraint<?>> accessConstraints) Sets access constraints.
protected ValueLoadContext	createLoadContext()
FluentValuesLoader	firstResult(int firstResult) Sets results offset.
FluentValuesLoader	hint(java.lang.String hintName, java.io.Serializable value) Sets custom hint that should be used by the query.
FluentValuesLoader	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<KeyValueEntity>	list() Loads a list of entities.
FluentValuesLoader	maxResults(int maxResults) Sets results limit.
KeyValueEntity	one() Loads a single instance.
java.util.Optional<KeyValueEntity>	optional() Loads a single instance and wraps it in Optional.
FluentValuesLoader	parameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType) Sets value for a parameter of java.util.Date type.
FluentValuesLoader	parameter(java.lang.String name, java.lang.Object value) Sets value for a query parameter.
FluentValuesLoader	parameter(java.lang.String name, java.lang.Object value, boolean implicitConversion) Sets value for a query parameter.
FluentValuesLoader	properties(java.util.List<java.lang.String> properties) The same as invoking property(String) multiple times.
FluentValuesLoader	properties(java.lang.String... properties) The same as invoking property(String) multiple times.
FluentValuesLoader	property(java.lang.String name) Adds a key of a returned key-value pair.
void	setDataManager(UnconstrainedDataManager dataManager)
FluentValuesLoader	setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Sets the map of query parameters.
FluentValuesLoader	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

FluentValuesLoader

public FluentValuesLoader(java.lang.String queryString)

Method Detail

createLoadContext

protected ValueLoadContext createLoadContext()

list

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

Loads a list of entities.

optional

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

Loads a single instance and wraps it in Optional.

one

public KeyValueEntity one()

Loads a single instance.

Throws:

java.lang.IllegalStateException - if nothing was loaded

property

public FluentValuesLoader property(java.lang.String name)

Adds a key of a returned key-value pair. The sequence of adding properties must conform to the sequence of result fields in the query "select" clause.

For example, if the query is select e.id, e.name from sample$Customer and you executed property("customerId").property("customerName"), the returned KeyValueEntity will contain customer identifiers in "customerId" property and names in "customerName" property.

properties

public FluentValuesLoader properties(java.util.List<java.lang.String> properties)

The same as invoking property(String) multiple times.

properties

public FluentValuesLoader properties(java.lang.String... properties)

The same as invoking property(String) multiple times.

store

public FluentValuesLoader store(java.lang.String store)

Sets DataStore name.

hint

public FluentValuesLoader hint(java.lang.String hintName,
                               java.io.Serializable value)

Sets custom hint that should be used by the query.

hints

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

Sets custom hints that should be used by the query.

parameter

public FluentValuesLoader parameter(java.lang.String name,
                                    java.lang.Object value)

Sets value for a query parameter.

Parameters:

name - parameter name

value - parameter value

parameter

public FluentValuesLoader 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 FluentValuesLoader 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 FluentValuesLoader setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Sets the map of query parameters.

firstResult

public FluentValuesLoader firstResult(int firstResult)

Sets results offset.

maxResults

public FluentValuesLoader 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()