ValueLoadContext (Jmix-core 1.2 API)

java.lang.Object
- io.jmix.core.ValueLoadContext

All Implemented Interfaces:: DataLoadContext, java.io.Serializable

public class ValueLoadContext
extends java.lang.Object
implements DataLoadContext, java.io.Serializable

Class that defines parameters for loading values from the database via UnconstrainedDataManager.loadValues(ValueLoadContext).

Typical usage:

 ValueLoadContext context = ValueLoadContext.create()
      .setQuery(ValueLoadContext.createQuery("select e.id, e.name from sample$Customer e where e.grade = :grade")
          .setParameter("grade", 1))
      .addProperty("id")
      .addProperty("name");

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ValueLoadContext.Query
Class that defines a query to be executed for loading values.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ValueLoadContext.Query` Class that defines a query to be executed for loading values.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<AccessConstraint<?>>`	`accessConstraints`
`protected java.util.Map<java.lang.String,java.io.Serializable>`	`hints`
`protected java.lang.String`	`idName`
`protected boolean`	`joinTransaction`
`protected java.util.List<java.lang.String>`	`properties`
`protected ValueLoadContext.Query`	`query`
`protected boolean`	`softDeletion`
`protected java.lang.String`	`storeName`

Constructor Summary

Constructors
Constructor and Description

ValueLoadContext()

Constructors
Constructor and Description
`ValueLoadContext()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ValueLoadContext`	`addProperty(java.lang.String name)` Adds a key of a returned key-value pair.
`static ValueLoadContext`	`create()` Creates an instance of ValueLoadContext
`static ValueLoadContext.Query`	`createQuery(java.lang.String queryString)` Creates an instance of ValueLoadContext query
`java.util.List<AccessConstraint<?>>`	`getAccessConstraints()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getHints()`
`java.lang.String`	`getIdName()`
`java.util.List<java.lang.String>`	`getProperties()`
`ValueLoadContext.Query`	`getQuery()`
`java.lang.String`	`getStoreName()`
`boolean`	`isJoinTransaction()`
`ValueLoadContext`	`setAccessConstraints(java.util.List<AccessConstraint<?>> accessConstraints)`
`ValueLoadContext`	`setHint(java.lang.String hintName, java.io.Serializable value)` Sets custom hint that should be used by the query.
`ValueLoadContext`	`setHints(java.util.Map<java.lang.String,java.io.Serializable> hints)` Sets custom hints that should be used by the query.
`void`	`setIdName(java.lang.String idName)` Sets name of the property that represents an identifier of the returned KeyValueEntity.
`ValueLoadContext`	`setJoinTransaction(boolean joinTransaction)`
`ValueLoadContext`	`setProperties(java.util.List<java.lang.String> properties)` The same as invoking `addProperty(String)` multiple times.
`ValueLoadContext`	`setQuery(ValueLoadContext.Query query)` Sets query instance
`ValueLoadContext.Query`	`setQueryString(java.lang.String queryString)`
`ValueLoadContext`	`setStoreName(java.lang.String storeName)` Sets a data store name if it is different from the main database.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - storeName
```
protected java.lang.String storeName
```
  - query
```
protected ValueLoadContext.Query query
```
  - softDeletion
```
protected boolean softDeletion
```
  - idName
```
protected java.lang.String idName
```
  - properties
```
protected java.util.List<java.lang.String> properties
```
  - accessConstraints
```
protected java.util.List<AccessConstraint<?>> accessConstraints
```
  - hints
```
protected java.util.Map<java.lang.String,java.io.Serializable> hints
```
  - joinTransaction
```
protected boolean joinTransaction
```
- Constructor Detail
  - ValueLoadContext
```
public ValueLoadContext()
```
- Method Detail
  - create
```
public static ValueLoadContext create()
```
    Creates an instance of ValueLoadContext
  - createQuery
```
public static ValueLoadContext.Query createQuery(java.lang.String queryString)
```
    Creates an instance of ValueLoadContext query
  - setQueryString
```
public ValueLoadContext.Query setQueryString(java.lang.String queryString)
```
    Specified by:
    
    setQueryString in interface DataLoadContext
    
    Parameters:
    
    queryString - JPQL query string. Only named parameters are supported.
    
    Returns:
    
    query definition object
  - getStoreName
```
public java.lang.String getStoreName()
```
    Returns:
    
    data store name if set by setStoreName(String)
  - setStoreName
```
public ValueLoadContext setStoreName(java.lang.String storeName)
```
    Sets a data store name if it is different from the main database.
    
    Returns:
    
    this instance for chaining
  - setQuery
```
public ValueLoadContext setQuery(ValueLoadContext.Query query)
```
    Sets query instance
    
    Returns:
    
    this instance for chaining
  - getQuery
```
public ValueLoadContext.Query getQuery()
```
    Returns:
    
    query instance
  - getHints
```
public java.util.Map<java.lang.String,java.lang.Object> getHints()
```
    Returns:
    
    custom hints which are used by the query
  - setHint
```
public ValueLoadContext setHint(java.lang.String hintName,
                                java.io.Serializable value)
```
    Sets custom hint that should be used by the query.
  - setHints
```
public ValueLoadContext setHints(java.util.Map<java.lang.String,java.io.Serializable> hints)
```
    Sets custom hints that should be used by the query.
  - getIdName
```
public java.lang.String getIdName()
```
    Returns:
    
    name of property that represents an identifier of the returned KeyValueEntity, if set by setIdName(String)
  - setIdName
```
public void setIdName(java.lang.String idName)
```
    Sets name of the property that represents an identifier of the returned KeyValueEntity.
  - addProperty
```
public ValueLoadContext addProperty(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 context.addProperty("customerId").addProperty("customerName"), the returned KeyValueEntity will contain customer identifiers in "customerId" property and names in "customerName" property.
    
    Returns:
    
    this instance for chaining
  - setProperties
```
public ValueLoadContext setProperties(java.util.List<java.lang.String> properties)
```
    The same as invoking addProperty(String) multiple times.
    
    Returns:
    
    this instance for chaining
  - getProperties
```
public java.util.List<java.lang.String> getProperties()
```
    Returns:
    
    the list of properties added by addProperty(String)
  - getAccessConstraints
```
public java.util.List<AccessConstraint<?>> getAccessConstraints()
```
  - setAccessConstraints
```
public ValueLoadContext setAccessConstraints(java.util.List<AccessConstraint<?>> accessConstraints)
```
  - isJoinTransaction
```
public boolean isJoinTransaction()
```
  - setJoinTransaction
```
public ValueLoadContext setJoinTransaction(boolean joinTransaction)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ValueLoadContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

storeName

query

softDeletion

idName

properties

accessConstraints

hints

joinTransaction

Constructor Detail

ValueLoadContext

Method Detail

create

createQuery

setQueryString

getStoreName

setStoreName

setQuery

getQuery

getHints

setHint

setHints

getIdName

setIdName

addProperty

setProperties

getProperties

getAccessConstraints

setAccessConstraints

isJoinTransaction

setJoinTransaction

toString