Package io.jmix.core.impl

Class FetchPlanRepositoryImpl

java.lang.Object

io.jmix.core.impl.FetchPlanRepositoryImpl

All Implemented Interfaces:

FetchPlanRepository

@Component("core_FetchPlanRepository")
public class FetchPlanRepositoryImpl
extends Object
implements FetchPlanRepository

Implementation of the FetchPlanRepository. Contains methods to store FetchPlan objects and deploy them from XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FetchPlanRepositoryImpl.State

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.core.env.Environment	environment
protected ExtendedEntities	extendedEntities
protected FetchPlanLoader	fetchPlanLoader
protected FetchPlans	fetchPlans
protected Metadata	metadata
protected MetadataGenerationManager	metadataGenerationManager
protected MetadataTools	metadataTools
protected JmixModules	modules
protected Resources	resources
protected final GenerationStateStore<FetchPlanRepositoryImpl.State>	stateStore

Constructor Summary

Constructors

Constructor	Description
FetchPlanRepositoryImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addAttributesToBaseFetchPlan(MetaClass metaClass, FetchPlanBuilder fetchPlanBuilder, FetchPlanLoader.FetchPlanInfo info, Set<FetchPlanLoader.FetchPlanInfo> visited)
protected void	addAttributesToInstanceNameFetchPlan(MetaClass metaClass, FetchPlanBuilder fetchPlanBuilder, FetchPlanLoader.FetchPlanInfo info, Set<FetchPlanLoader.FetchPlanInfo> visited)
protected void	addAttributesToLocalFetchPlan(MetaClass metaClass, FetchPlanBuilder fetchPlanBuilder)
protected void	addClassAttributeWithFetchPlan(MetaProperty metaProperty, String fetchPlanName, FetchPlanBuilder fetchPlanBuilder, FetchPlanLoader.FetchPlanInfo info, Set<FetchPlanLoader.FetchPlanInfo> visited)
protected void	addFile(FetchPlanRepositoryImpl.State state, org.dom4j.Element commonRootElem, String fileName)
protected void	checkInitialized(FetchPlanRepositoryImpl.State state)
protected FetchPlan	createKeyValueFetchPlan(KeyValueMetaClass metaClass, String name)
protected FetchPlan	deployDefaultFetchPlan(FetchPlanRepositoryImpl.State state, MetaClass metaClass, String name, Set<FetchPlanLoader.FetchPlanInfo> visited)
FetchPlan	deployFetchPlan(FetchPlanRepositoryImpl.State state, org.dom4j.Element rootElem, org.dom4j.Element fetchPlanElem)
protected FetchPlan	deployFetchPlan(FetchPlanRepositoryImpl.State state, org.dom4j.Element rootElem, org.dom4j.Element fetchPlanElem, Set<FetchPlanLoader.FetchPlanInfo> visited)
void	deployFetchPlans(InputStream xml)
void	deployFetchPlans(Reader xml)
void	deployFetchPlans(String resourceUrl)
@Nullable FetchPlan	findFetchPlan(MetaClass metaClass, String name)	Searches for a FetchPlan for an entity
List<FetchPlan>	getAll()
protected List<FetchPlan>	getAllInitialized(FetchPlanRepositoryImpl.State state)
protected FetchPlan	getAncestorFetchPlan(MetaClass metaClass, String ancestor, Set<FetchPlanLoader.FetchPlanInfo> visited)
FetchPlan	getFetchPlan(MetaClass metaClass, String name)	Get FetchPlan for an entity.
FetchPlan	getFetchPlan(Class<?> entityClass, String name)	Get FetchPlan for an entity.
Collection<String>	getFetchPlanNames(MetaClass metaClass)	Returns names of fetch plans defined for the metaClass
Collection<String>	getFetchPlanNames(Class<?> entityClass)	Returns names of fetch plans defined for the entityClass
protected Collection<MetaProperty>	getInstanceNamePersistentProperties(MetaClass metaClass)
protected FetchPlanRepositoryImpl.State	getState()
protected void	init(FetchPlanRepositoryImpl.State state)
protected boolean	isDefaultFetchPlan(String fetchPlanName)
protected boolean	isPersistent(MetaClass metaClass, MetaProperty metaProperty)
void	onMetadataGenerationRetired(MetadataGenerationRetiredEvent event)	Drops fetch-plan state cached for a retired metadata generation.
protected @Nullable FetchPlanBuilder	replaceOverridden(FetchPlan root, FetchPlan replacementFetchPlan, HashSet<FetchPlan> checked)
protected void	replaceOverridden(FetchPlanRepositoryImpl.State state, FetchPlan replacementFetchPlan)
void	reset()
protected @Nullable FetchPlan	retrieveFetchPlan(FetchPlanRepositoryImpl.State state, MetaClass metaClass, String name, Set<FetchPlanLoader.FetchPlanInfo> visited)
protected void	storeFetchPlan(FetchPlanRepositoryImpl.State state, MetaClass metaClass, FetchPlan fetchPlan)

Methods inherited from class java.lang.Object

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

Field Details

environment

@Autowired
protected org.springframework.core.env.Environment environment

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

extendedEntities

@Autowired
protected ExtendedEntities extendedEntities

resources

@Autowired
protected Resources resources

modules

@Autowired
protected JmixModules modules

fetchPlans

@Lazy
@Autowired
protected FetchPlans fetchPlans

fetchPlanLoader

@Autowired
protected FetchPlanLoader fetchPlanLoader

metadataGenerationManager

@Autowired
protected MetadataGenerationManager metadataGenerationManager

stateStore

protected final GenerationStateStore<FetchPlanRepositoryImpl.State> stateStore

Constructor Details

FetchPlanRepositoryImpl

public FetchPlanRepositoryImpl()

Method Details

getState

protected FetchPlanRepositoryImpl.State getState()

checkInitialized

protected void checkInitialized(FetchPlanRepositoryImpl.State state)

init

protected void init(FetchPlanRepositoryImpl.State state)

addFile

protected void addFile(FetchPlanRepositoryImpl.State state,
 org.dom4j.Element commonRootElem,
 String fileName)

reset

@EventListener(org.springframework.context.event.ContextRefreshedEvent.class)
@Order(140)
public void reset()

onMetadataGenerationRetired

@EventListener
public void onMetadataGenerationRetired(MetadataGenerationRetiredEvent event)

Drops fetch-plan state cached for a retired metadata generation.

Parameters:

event - retired-generation event

getFetchPlan

public FetchPlan getFetchPlan(Class<?> entityClass,
 String name)

Get FetchPlan for an entity.

Specified by:

getFetchPlan in interface FetchPlanRepository

Parameters:

entityClass - entity class

name - fetch plan name

Returns:

fetch plan instance. Throws FetchPlanNotFoundException if not found.

getFetchPlan

public FetchPlan getFetchPlan(MetaClass metaClass,
 String name)

Get FetchPlan for an entity.

Specified by:

getFetchPlan in interface FetchPlanRepository

Parameters:

metaClass - entity class

name - fetch plan name

Returns:

fetch plan instance. Throws FetchPlanNotFoundException if not found.

findFetchPlan

public @Nullable FetchPlan findFetchPlan(MetaClass metaClass,
 String name)

Searches for a FetchPlan for an entity

Specified by:

findFetchPlan in interface FetchPlanRepository

Parameters:

metaClass - entity class

name - fetch plan name

Returns:

fetch plan instance or null if no fetch plan found

getFetchPlanNames

public Collection<String> getFetchPlanNames(MetaClass metaClass)

Description copied from interface: FetchPlanRepository

Returns names of fetch plans defined for the metaClass

Specified by:

getFetchPlanNames in interface FetchPlanRepository

Parameters:

metaClass - entity class

Returns:

names of fetch plans

getFetchPlanNames

public Collection<String> getFetchPlanNames(Class<?> entityClass)

Description copied from interface: FetchPlanRepository

Returns names of fetch plans defined for the entityClass

Specified by:

getFetchPlanNames in interface FetchPlanRepository

Parameters:

entityClass - entity class

Returns:

names of fetch plans

deployDefaultFetchPlan

protected FetchPlan deployDefaultFetchPlan(FetchPlanRepositoryImpl.State state,
 MetaClass metaClass,
 String name,
 Set<FetchPlanLoader.FetchPlanInfo> visited)

createKeyValueFetchPlan

protected FetchPlan createKeyValueFetchPlan(KeyValueMetaClass metaClass,
 String name)

addAttributesToLocalFetchPlan

protected void addAttributesToLocalFetchPlan(MetaClass metaClass,
 FetchPlanBuilder fetchPlanBuilder)

addAttributesToInstanceNameFetchPlan

protected void addAttributesToInstanceNameFetchPlan(MetaClass metaClass,
 FetchPlanBuilder fetchPlanBuilder,
 FetchPlanLoader.FetchPlanInfo info,
 Set<FetchPlanLoader.FetchPlanInfo> visited)

addAttributesToBaseFetchPlan

protected void addAttributesToBaseFetchPlan(MetaClass metaClass,
 FetchPlanBuilder fetchPlanBuilder,
 FetchPlanLoader.FetchPlanInfo info,
 Set<FetchPlanLoader.FetchPlanInfo> visited)

addClassAttributeWithFetchPlan

protected void addClassAttributeWithFetchPlan(MetaProperty metaProperty,
 String fetchPlanName,
 FetchPlanBuilder fetchPlanBuilder,
 FetchPlanLoader.FetchPlanInfo info,
 Set<FetchPlanLoader.FetchPlanInfo> visited)

isPersistent

protected boolean isPersistent(MetaClass metaClass,
 MetaProperty metaProperty)

getInstanceNamePersistentProperties

protected Collection<MetaProperty> getInstanceNamePersistentProperties(MetaClass metaClass)

deployFetchPlans

public void deployFetchPlans(String resourceUrl)

deployFetchPlans

public void deployFetchPlans(InputStream xml)

deployFetchPlans

public void deployFetchPlans(Reader xml)

retrieveFetchPlan

protected @Nullable FetchPlan retrieveFetchPlan(FetchPlanRepositoryImpl.State state,
 MetaClass metaClass,
 String name,
 Set<FetchPlanLoader.FetchPlanInfo> visited)

isDefaultFetchPlan

protected boolean isDefaultFetchPlan(String fetchPlanName)

deployFetchPlan

public FetchPlan deployFetchPlan(FetchPlanRepositoryImpl.State state,
 org.dom4j.Element rootElem,
 org.dom4j.Element fetchPlanElem)

deployFetchPlan

protected FetchPlan deployFetchPlan(FetchPlanRepositoryImpl.State state,
 org.dom4j.Element rootElem,
 org.dom4j.Element fetchPlanElem,
 Set<FetchPlanLoader.FetchPlanInfo> visited)

replaceOverridden

protected void replaceOverridden(FetchPlanRepositoryImpl.State state,
 FetchPlan replacementFetchPlan)

replaceOverridden

protected @Nullable FetchPlanBuilder replaceOverridden(FetchPlan root,
 FetchPlan replacementFetchPlan,
 HashSet<FetchPlan> checked)

Returns:

FetchPlanBuilder to replace root or null if no replacement needed

getAncestorFetchPlan

protected FetchPlan getAncestorFetchPlan(MetaClass metaClass,
 String ancestor,
 Set<FetchPlanLoader.FetchPlanInfo> visited)

storeFetchPlan

protected void storeFetchPlan(FetchPlanRepositoryImpl.State state,
 MetaClass metaClass,
 FetchPlan fetchPlan)

getAllInitialized

protected List<FetchPlan> getAllInitialized(FetchPlanRepositoryImpl.State state)

getAll

public List<FetchPlan> getAll()