io.jmix.core.datastore

Class AbstractDataStore

java.lang.Object

io.jmix.core.datastore.AbstractDataStore

All Implemented Interfaces:

DataStore

public abstract class AbstractDataStore
extends java.lang.Object
implements DataStore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractDataStore.EntityLoadInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityStates	entityStates
protected KeyValueMapper	keyValueMapper
protected java.util.List<DataStoreEventListener>	listeners
protected Metadata	metadata
protected MetadataTools	metadataTools

Constructor Summary

Constructors

Constructor and Description
AbstractDataStore()

Method Summary

Modifier and Type	Method and Description
protected void	beforeLoadTransactionCommit(LoadContext<?> context, java.util.Collection<java.lang.Object> entities)
protected void	beforeSaveTransactionCommit(SaveContext context, java.util.Collection<java.lang.Object> savedEntities, java.util.Collection<java.lang.Object> removedEntities)
protected void	beforeSaveTransactionRollback(SaveContext context)
protected abstract java.lang.Object	beginLoadTransaction(boolean joinTransaction)
protected abstract java.lang.Object	beginSaveTransaction(boolean joinTransaction)
protected java.util.List<java.lang.Object>	checkAndReorderLoadedEntities(LoadContext<?> context, java.util.List<java.lang.Object> entities)
protected abstract void	commitTransaction(java.lang.Object transaction)
protected void	copyNonPersistentAttributes(java.lang.Object source, java.lang.Object destination)
protected abstract long	countAll(LoadContext<?> context)
protected abstract long	countAllValues(ValueLoadContext context)
protected abstract java.util.Set<java.lang.Object>	deleteAll(SaveContext context)
protected <T extends BaseDataStoreEvent> void	fireEvent(T event)
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.
protected FetchPlan	getFetchPlanForSave(java.util.Map<java.lang.Object,FetchPlan> fetchPlans, java.lang.Object entity)
java.lang.Object	load(LoadContext<?> context) Loads a single entity instance.
protected abstract java.util.List<java.lang.Object>	loadAll(LoadContext<?> context)
protected java.util.Set<java.lang.Object>	loadAllAfterSave(SaveContext context, java.util.Set<java.lang.Object> savedEntities)
protected abstract java.util.List<java.lang.Object>	loadAllValues(ValueLoadContext context)
java.util.List<java.lang.Object>	loadList(LoadContext<?> context) Loads collection of entity instances.
protected java.util.List<java.lang.Object>	loadListByBatches(LoadContext<?> context, int actualSize, EventSharedState eventState)
protected abstract java.lang.Object	loadOne(LoadContext<?> context)
java.util.List<KeyValueEntity>	loadValues(ValueLoadContext context) Loads list of key-value pairs.
void	registerInterceptor(DataStoreEventListener listener)
protected abstract void	rollbackTransaction(java.lang.Object transaction)
java.util.Set<?>	save(SaveContext context) Saves a collection of entity instances.
protected abstract java.util.Set<java.lang.Object>	saveAll(SaveContext context)
void	setEntityStates(EntityStates entityStates)
void	setKeyValueMapper(KeyValueMapper keyValueMapper)
void	setMetadata(Metadata metadata)
void	setMetadataTools(MetadataTools metadataTools)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.core.DataStore

getName, setName

Field Detail

listeners

protected final java.util.List<DataStoreEventListener> listeners

metadata

protected Metadata metadata

metadataTools

protected MetadataTools metadataTools

entityStates

protected EntityStates entityStates

keyValueMapper

protected KeyValueMapper keyValueMapper

Constructor Detail

AbstractDataStore

public AbstractDataStore()

Method Detail

setMetadata

@Autowired
public void setMetadata(Metadata metadata)

setMetadataTools

@Autowired
public void setMetadataTools(MetadataTools metadataTools)

setEntityStates

@Autowired
public void setEntityStates(EntityStates entityStates)

setKeyValueMapper

@Autowired
public void setKeyValueMapper(KeyValueMapper keyValueMapper)

load

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

Description copied from interface: DataStore

Loads a single entity instance.

Specified by:

load in interface DataStore

Returns:

the loaded object, or null if not found

loadList

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

Description copied from interface: DataStore

Loads collection of entity instances.

Specified by:

loadList in interface DataStore

Returns:

a list of instances, or empty list if nothing found

getCount

public long getCount(LoadContext<?> context)

Description copied from interface: DataStore

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

Specified by:

getCount in interface DataStore

Returns:

number of instances in the storage

save

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

Description copied from interface: DataStore

Saves a collection of entity instances.

Specified by:

save in interface DataStore

Returns:

set of saved instances

loadValues

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

Description copied from interface: DataStore

Loads list of key-value pairs.

Specified by:

loadValues in interface DataStore

Parameters:

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

Returns:

list of KeyValueEntity instances

getCount

public long getCount(ValueLoadContext context)

Description copied from interface: DataStore

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

Specified by:

getCount in interface DataStore

Parameters:

context - defines the query

Returns:

number of key-value pairs in the data store

loadOne

@Nullable
protected abstract java.lang.Object loadOne(LoadContext<?> context)

loadAll

protected abstract java.util.List<java.lang.Object> loadAll(LoadContext<?> context)

countAll

protected abstract long countAll(LoadContext<?> context)

saveAll

protected abstract java.util.Set<java.lang.Object> saveAll(SaveContext context)

deleteAll

protected abstract java.util.Set<java.lang.Object> deleteAll(SaveContext context)

loadAllValues

protected abstract java.util.List<java.lang.Object> loadAllValues(ValueLoadContext context)

countAllValues

protected abstract long countAllValues(ValueLoadContext context)

beginLoadTransaction

protected abstract java.lang.Object beginLoadTransaction(boolean joinTransaction)

beginSaveTransaction

protected abstract java.lang.Object beginSaveTransaction(boolean joinTransaction)

commitTransaction

protected abstract void commitTransaction(java.lang.Object transaction)

rollbackTransaction

protected abstract void rollbackTransaction(java.lang.Object transaction)

beforeLoadTransactionCommit

protected void beforeLoadTransactionCommit(LoadContext<?> context,
                                           java.util.Collection<java.lang.Object> entities)

beforeSaveTransactionCommit

protected void beforeSaveTransactionCommit(SaveContext context,
                                           java.util.Collection<java.lang.Object> savedEntities,
                                           java.util.Collection<java.lang.Object> removedEntities)

beforeSaveTransactionRollback

protected void beforeSaveTransactionRollback(SaveContext context)

registerInterceptor

public void registerInterceptor(DataStoreEventListener listener)

fireEvent

protected <T extends BaseDataStoreEvent> void fireEvent(T event)

loadListByBatches

protected java.util.List<java.lang.Object> loadListByBatches(LoadContext<?> context,
                                                             int actualSize,
                                                             EventSharedState eventState)

checkAndReorderLoadedEntities

protected java.util.List<java.lang.Object> checkAndReorderLoadedEntities(LoadContext<?> context,
                                                                         java.util.List<java.lang.Object> entities)

loadAllAfterSave

protected java.util.Set<java.lang.Object> loadAllAfterSave(SaveContext context,
                                                           java.util.Set<java.lang.Object> savedEntities)

getFetchPlanForSave

protected FetchPlan getFetchPlanForSave(java.util.Map<java.lang.Object,FetchPlan> fetchPlans,
                                        java.lang.Object entity)

copyNonPersistentAttributes

protected void copyNonPersistentAttributes(java.lang.Object source,
                                           java.lang.Object destination)