io.jmix.core

Interface DataStore

All Known Implementing Classes:

AbstractDataStore, NoopDataStore

public interface DataStore

Interface defining methods for CRUD operations on entities.

Implementations of this interface must be prototype beans. They are used by DataManager, do not access data stores directly from your application code.

Method Summary

Modifier and Type	Method and Description
long	getCount(LoadContext<?> context) Returns the number of entity instances for the given query passed in the LoadContext.
long	getCount(ValueLoadContext context) Returns the number of key-value pairs for the given query passed in the ValueLoadContext.
java.lang.String	getName() This data store instance name with which it is registered in Stores.
java.lang.Object	load(LoadContext<?> context) Loads a single entity instance.
java.util.List<java.lang.Object>	loadList(LoadContext<?> context) Loads collection of entity instances.
java.util.List<KeyValueEntity>	loadValues(ValueLoadContext context) Loads list of key-value pairs.
java.util.Set<?>	save(SaveContext context) Saves a collection of entity instances.
void	setName(java.lang.String name) Sets this data store instance name with which it is registered in Stores.

Method Detail

getName

java.lang.String getName()

This data store instance name with which it is registered in Stores.

setName

void setName(java.lang.String name)

Sets this data store instance name with which it is registered in Stores.

load

@Nullable
java.lang.Object load(LoadContext<?> context)

Loads a single entity instance.

Returns:

the loaded object, or null if not found

loadList

java.util.List<java.lang.Object> loadList(LoadContext<?> context)

Loads collection of entity instances.

Returns:

a list of instances, or empty list if nothing found

getCount

long getCount(LoadContext<?> context)

Returns the number of entity instances for the given query passed in the LoadContext.

Returns:

number of instances in the storage

save

java.util.Set<?> save(SaveContext context)

Saves a collection of entity instances.

Returns:

set of saved instances

loadValues

java.util.List<KeyValueEntity> loadValues(ValueLoadContext context)

Loads list of key-value pairs.

Parameters:

context - defines a query for scalar values and a list of keys for returned KeyValueEntity

Returns:

list of KeyValueEntity instances

getCount

long getCount(ValueLoadContext context)

Returns the number of key-value pairs for the given query passed in the ValueLoadContext.

Parameters:

context - defines the query

Returns:

number of key-value pairs in the data store