Package io.jmix.datatools.datamodel

Class DataModelRegistry

java.lang.Object

io.jmix.datatools.datamodel.DataModelRegistry

@Component("datatl_DataModelProvider")
public class DataModelRegistry
extends Object

Provides information about entity data models organized by data stores.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DataModelRegistry.State

Field Summary

Fields

Modifier and Type	Field	Description
protected DbmsType	dbmsType
protected DiagramEngine	diagramEngine
protected Metadata	metadata
protected MetadataGenerationManager	metadataGenerationManager
protected MetadataTools	metadataTools
protected final GenerationStateStore<DataModelRegistry.State>	stateStore
protected StoreAwareLocator	storeAwareLocator

Constructor Summary

Constructors

Constructor	Description
DataModelRegistry()

Method Summary

Modifier and Type	Method	Description
protected void	addDatatypeAttribute(MetaClass entity, boolean isEmbeddable, MetaProperty field, String fieldName, List<AttributeModel> attributeModelsList)
protected void	addElementCollectionAttribute(MetaClass entity, MetaProperty field, String fieldName, List<AttributeModel> attributeModelsList)
protected void	addEmbeddedAttribute(DataModelRegistry.State state, MetaClass entity, MetaProperty field, String fieldName, List<AttributeModel> attributeModelsList)
protected void	addManyToManyAttribute(MetaClass entity, MetaProperty field, String fieldName, String dataStoreName, Map<RelationType,List<Relation>> relationsMap, List<AttributeModel> attributeModelsList)
protected void	addManyToOneAttribute(MetaClass entity, boolean isEmbeddable, MetaProperty field, String fieldName, List<AttributeModel> attributeModelsList, String dataStoreName, Map<RelationType,List<Relation>> relationsMap)
protected void	addOneToManyAttribute(MetaClass entity, MetaProperty field, String fieldName, String dataStoreName, Map<RelationType,List<Relation>> relationsMap, List<AttributeModel> attributeModelsList)
protected void	addOneToOneAttribute(MetaClass entity, boolean isEmbeddable, MetaProperty field, String fieldName, String dataStoreName, Map<RelationType,List<Relation>> relationsMap, List<AttributeModel> attributeModelsList)
protected String	applyRegister(String name, String storeName)
protected void	checkInitialized(DataModelRegistry.State state)
protected AttributeModel	constructAttribute(String fieldName, String fieldType)
protected AttributeModel	constructAttribute(String fieldName, String fieldType, boolean isMandatory)
protected AttributeModel	constructAttribute(String columnName, String fieldName, String fieldType, MetaClass entity, boolean isMandatory)
protected AttributeModel	constructAttribute(String columnName, String fieldName, String fieldType, String dbType, boolean isMandatory)
protected void	constructDataModel(DataModelRegistry.State state)
protected EntityModel	constructEntityModel(MetaClass entity, boolean isSystem)
protected DataModel	createEntityDescription(DataModelRegistry.State state, MetaClass entity, boolean isEmbeddable)
protected MetaClass	findEntityForField(MetaClass entity, MetaProperty field)	Finds the most appropriate MetaClass representation of the entity to which a given field belongs.
protected <T extends Annotation> T	getAnnotation(MetaProperty field, Class<T> annotationClass)
protected @Nullable String	getCatalogName(jakarta.persistence.Table annotation)
protected String	getDatabaseColumnType(MetaClass entity, String columnName)
protected String	getDatabaseColumnType(String storeName, @Nullable String schemaName, @Nullable String catalogName, String tableName, String columnName)
Map<String,Map<String,DataModel>>	getDataModels()	Retrieves an unmodifiable view of the internal data model storage.
Map<String,DataModel>	getDataModels(String dataStore)	Retrieves the data models associated with a specific data store.
Set<String>	getDataStoreNames()
protected String	getElementTypeFromCollection(MetaProperty metaProperty)
protected @Nullable String	getSchemaName(jakarta.persistence.Table annotation)
protected DataModelRegistry.State	getState()
protected void	init(DataModelRegistry.State state)
protected boolean	isAnnotationPresent(MetaProperty field, Class<? extends Annotation> annotationClass)
void	onMetadataGenerationRetired(MetadataGenerationRetiredEvent event)	Removes registry state cached for a retired metadata generation.
protected void	putDataModel(DataModelRegistry.State state, DataModel dataModel)
protected void	putRelation(Map<RelationType,List<Relation>> relations, RelationType relationType, Relation relation)
void	reset()	Make the registry to reload data models on the next request.

Methods inherited from class java.lang.Object

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

Field Details

dbmsType

@Autowired
protected DbmsType dbmsType

metadata

@Autowired
protected Metadata metadata

diagramEngine

@Autowired
protected DiagramEngine diagramEngine

metadataTools

@Autowired
protected MetadataTools metadataTools

storeAwareLocator

@Autowired
protected StoreAwareLocator storeAwareLocator

metadataGenerationManager

@Autowired
protected MetadataGenerationManager metadataGenerationManager

stateStore

protected final GenerationStateStore<DataModelRegistry.State> stateStore

Constructor Details

DataModelRegistry

public DataModelRegistry()

Method Details

getState

protected DataModelRegistry.State getState()

reset

public void reset()

Make the registry to reload data models on the next request.

onMetadataGenerationRetired

@EventListener
public void onMetadataGenerationRetired(MetadataGenerationRetiredEvent event)

Removes registry state cached for a retired metadata generation.

Parameters:

event - retired-generation event

checkInitialized

protected void checkInitialized(DataModelRegistry.State state)

init

protected void init(DataModelRegistry.State state)

constructDataModel

protected void constructDataModel(DataModelRegistry.State state)

createEntityDescription

protected DataModel createEntityDescription(DataModelRegistry.State state,
 MetaClass entity,
 boolean isEmbeddable)

addDatatypeAttribute

protected void addDatatypeAttribute(MetaClass entity,
 boolean isEmbeddable,
 MetaProperty field,
 String fieldName,
 List<AttributeModel> attributeModelsList)

findEntityForField

protected MetaClass findEntityForField(MetaClass entity,
 MetaProperty field)

Finds the most appropriate MetaClass representation of the entity to which a given field belongs. It checks the declaring class of the field and navigates through the entity's inheritance hierarchy to locate the last JPA entity associated with the given field.

NOTE: needed for inheritance strategy 'JOINED'.

Parameters:

entity - the initial MetaClass representing the starting point for the search in the hierarchy

field - the MetaProperty representing the field whose associated entity is to be determined

Returns:

the MetaClass representing the most specific JPA entity associated with the field or the initial entity if no more specific JPA entity could be found

addEmbeddedAttribute

protected void addEmbeddedAttribute(DataModelRegistry.State state,
 MetaClass entity,
 MetaProperty field,
 String fieldName,
 List<AttributeModel> attributeModelsList)

addManyToOneAttribute

protected void addManyToOneAttribute(MetaClass entity,
 boolean isEmbeddable,
 MetaProperty field,
 String fieldName,
 List<AttributeModel> attributeModelsList,
 String dataStoreName,
 Map<RelationType,List<Relation>> relationsMap)

addOneToManyAttribute

protected void addOneToManyAttribute(MetaClass entity,
 MetaProperty field,
 String fieldName,
 String dataStoreName,
 Map<RelationType,List<Relation>> relationsMap,
 List<AttributeModel> attributeModelsList)

addOneToOneAttribute

protected void addOneToOneAttribute(MetaClass entity,
 boolean isEmbeddable,
 MetaProperty field,
 String fieldName,
 String dataStoreName,
 Map<RelationType,List<Relation>> relationsMap,
 List<AttributeModel> attributeModelsList)

addManyToManyAttribute

protected void addManyToManyAttribute(MetaClass entity,
 MetaProperty field,
 String fieldName,
 String dataStoreName,
 Map<RelationType,List<Relation>> relationsMap,
 List<AttributeModel> attributeModelsList)

addElementCollectionAttribute

protected void addElementCollectionAttribute(MetaClass entity,
 MetaProperty field,
 String fieldName,
 List<AttributeModel> attributeModelsList)

constructEntityModel

protected EntityModel constructEntityModel(MetaClass entity,
 boolean isSystem)

putRelation

protected void putRelation(Map<RelationType,List<Relation>> relations,
 RelationType relationType,
 Relation relation)

constructAttribute

protected AttributeModel constructAttribute(String fieldName,
 String fieldType)

constructAttribute

protected AttributeModel constructAttribute(String fieldName,
 String fieldType,
 boolean isMandatory)

constructAttribute

protected AttributeModel constructAttribute(String columnName,
 String fieldName,
 String fieldType,
 MetaClass entity,
 boolean isMandatory)

constructAttribute

protected AttributeModel constructAttribute(String columnName,
 String fieldName,
 String fieldType,
 String dbType,
 boolean isMandatory)

getDatabaseColumnType

protected String getDatabaseColumnType(String storeName,
 @Nullable String schemaName,
 @Nullable String catalogName,
 String tableName,
 String columnName)

getDatabaseColumnType

protected String getDatabaseColumnType(MetaClass entity,
 String columnName)

applyRegister

protected String applyRegister(String name,
 String storeName)

getCatalogName

protected @Nullable String getCatalogName(jakarta.persistence.Table annotation)

getSchemaName

protected @Nullable String getSchemaName(jakarta.persistence.Table annotation)

putDataModel

protected void putDataModel(DataModelRegistry.State state,
 DataModel dataModel)

getDataStoreNames

public Set<String> getDataStoreNames()

getDataModels

public Map<String,Map<String,DataModel>> getDataModels()

Retrieves an unmodifiable view of the internal data model storage. The returned map represents an organizational structure where the first-level keys are data store identifiers and the values are nested maps. The nested maps use entity names as keys and their corresponding DataModel objects as values.

Returns:

a map containing data store identifiers as keys, where each value is another map that maps entity names to their respective DataModel instances. The returned map is unmodifiable.

getDataModels

public Map<String,DataModel> getDataModels(String dataStore)

Retrieves the data models associated with a specific data store.

Parameters:

dataStore - the name of the data store whose data models are to be retrieved; must not be null

Returns:

a map where the keys are entity names and the values are the corresponding DataModel instances

isAnnotationPresent

protected boolean isAnnotationPresent(MetaProperty field,
 Class<? extends Annotation> annotationClass)

getAnnotation

protected <T extends Annotation> T getAnnotation(MetaProperty field,
 Class<T> annotationClass)

getElementTypeFromCollection

protected String getElementTypeFromCollection(MetaProperty metaProperty)