Interface LoadedValuesCollector

public interface LoadedValuesCollector

Used to collect entity and collection values which are loaded as part of JdbcValues processing. Kept as part of JdbcValuesSourceProcessingState

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	LoadedValuesCollector.LoadedCollectionRegistration	Details about a loaded collection.
static final record	LoadedValuesCollector.LoadedEntityRegistration	Details about a loaded entity.
static interface	LoadedValuesCollector.LoadedPartRegistration

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the state of the collector.
List<LoadedValuesCollector.LoadedCollectionRegistration>	getCollectedCollections()	Access to all collection loaded.
List<LoadedValuesCollector.LoadedEntityRegistration>	getCollectedEntities()	Access to all root entities loaded.
void	registerCollection(NavigablePath navigablePath, PluralAttributeMapping collectionDescriptor, CollectionKey collectionKey)	Register a loading collection.
void	registerEntity(NavigablePath navigablePath, EntityMappingType entityDescriptor, EntityKey entityKey)	Register a loading entity.

Method Details

registerEntity

void registerEntity(NavigablePath navigablePath,
 EntityMappingType entityDescriptor,
 EntityKey entityKey)

Register a loading entity.

Parameters:

navigablePath - The NavigablePath relative to the SQL AST used to load the entity

entityDescriptor - The descriptor for the entity being loaded.

entityKey - The EntityKey for the entity being loaded

registerCollection

void registerCollection(NavigablePath navigablePath,
 PluralAttributeMapping collectionDescriptor,
 CollectionKey collectionKey)

Register a loading collection.

Parameters:

navigablePath - The NavigablePath relative to the SQL AST used to load the entity

collectionDescriptor - The descriptor for the collection being loaded.

collectionKey - The CollectionKey for the collection being loaded

clear

void clear()

Clears the state of the collector.

Implementation Specification:

In some cases, the collector may be cached as part of a JdbcSelect being cached (see JdbcSelect.getLoadedValuesCollector(). This method allows clearing of the internal state after execution of the JdbcSelect.

getCollectedEntities

List<LoadedValuesCollector.LoadedEntityRegistration> getCollectedEntities()

Access to all root entities loaded.

getCollectedCollections

List<LoadedValuesCollector.LoadedCollectionRegistration> getCollectedCollections()

Access to all collection loaded.