Package io.jmix.dynmodelflowui.impl

Class DynamicModelDefinitionModelConverter

java.lang.Object

io.jmix.dynmodelflowui.impl.DynamicModelDefinitionModelConverter

@Component("dynmod_DynamicModelDefinitionModelConverter")
public class DynamicModelDefinitionModelConverter
extends Object

Converts dynamic model definitions between YAML content, immutable metadata definition records and mutable model entities used by the Admin UI graphical editor.

The converter delegates YAML root parsing and writing to DynamicModelDefinitionSerializer so generated content stays compatible with the existing dynamic model YAML serializer. Nested arbitrary object maps, such as validation parameters and view template parameters, are represented in DTOs as YAML fragments to preserve their original value types.

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassManager	classManager
static final List<String>	LOOKUP_ACTION_IDS	Canonical order of lookup picker actions as written to YAML and offered in the settings UI.
protected Metadata	metadata
protected DynamicModelDefinitionSerializer	serializer
protected final com.fasterxml.jackson.databind.ObjectMapper	yamlMapper

Constructor Summary

Constructors

Constructor	Description
DynamicModelDefinitionModelConverter()

Method Summary

Modifier and Type	Method	Description
protected @Nullable String	blankToNull(@Nullable String value)
protected <T> T	create(Class<T> entityClass)
DynamicModelDefinitionModel	deserialize(String content)	Deserializes YAML content into a mutable model graph.
protected String	emptyIfNull(@Nullable String value)
protected @Nullable DynamicAttributeResourceRolesModel	fromAttributeAccessDefinition(@Nullable DynamicAttributeAccessDefinition definition)
protected DynamicAttributeConstraintModel	fromAttributeConstraintDefinition(DynamicAttributeConstraintDefinition definition)
protected DynamicAttributeModel	fromAttributeDefinition(DynamicAttributeDefinition definition)
protected List<DynamicAttributeConstraintModel>	fromAttributeValidation(@Nullable DynamicValidationDefinition<DynamicAttributeConstraintDefinition> validation)
protected @Nullable DynamicCalculatedAttributeModel	fromCalculatedAttributeDefinition(@Nullable DynamicCalculatedAttributeDefinition definition)
DynamicModelDefinitionModel	fromDefinition(DynamicModelDefinition definition)	Converts an immutable dynamic model definition into a mutable model graph.
protected @Nullable DynamicEntityResourceRolesModel	fromEntityAccessDefinition(@Nullable DynamicEntityAccessDefinition definition)
protected DynamicEntityConstraintModel	fromEntityConstraintDefinition(DynamicEntityConstraintDefinition definition)
protected DynamicEntityModel	fromEntityDefinition(DynamicEntityDefinition definition)
protected List<DynamicEntityConstraintModel>	fromEntityValidation(@Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation)
protected DynamicEnumerationModel	fromEnumerationDefinition(DynamicEnumerationDefinition definition)
protected DynamicEnumerationValueModel	fromEnumerationValueDefinition(DynamicEnumerationValueDefinition definition)
protected List<DynamicViewHandlerModel>	fromHandlerList(@Nullable List<DynamicViewHandlerDefinition> handlers)
protected @Nullable DynamicLocalizedValueModel	fromLocalizedValue(@Nullable LocalizedValue value)
protected List<DynamicStringValueModel>	fromMenuAccessDefinition(@Nullable DynamicMenuAccessDefinition definition)
protected @Nullable DynamicMenuItemModel	fromMenuItemDefinition(@Nullable MenuItemDefinition definition)
protected List<DynamicLocalizedMessageModel>	fromMessageMap(@Nullable Map<String,String> messages)
protected List<DynamicKeyValueModel>	fromObjectMap(@Nullable Map<String,Object> values)
protected List<DynamicStringValueModel>	fromStringList(List<String> values)
protected DynamicUniqueConstraintModel	fromUniqueConstraintDefinition(DynamicUniqueConstraintDefinition definition)
protected List<DynamicStringValueModel>	fromViewAccessDefinition(@Nullable DynamicViewAccessDefinition definition)
protected DynamicViewModel	fromViewDefinition(DynamicViewDefinition definition)
protected @Nullable DynamicViewDescriptorModel	fromViewDescriptorDefinition(@Nullable DynamicViewDescriptorDefinition definition)
protected boolean	isBlank(@Nullable String value)
protected boolean	isTrue(@Nullable Boolean value)
protected void	keepFirstInstanceNameFlag(List<DynamicAttributeModel> attributes)	Clears the instance-name flag on every attribute after the first flagged one.
protected @Nullable Class<?>	loadClassOrNull(@Nullable String attributeName, @Nullable String className)	Loads a class named in the graphical model.
protected @Nullable Object	readYamlFragment(@Nullable String valueYaml)
String	serialize(DynamicModelDefinitionModel model)	Serializes a mutable model graph into YAML content.
String	serialize(DynamicModelDefinitionModel model, @Nullable String existingContent)	Serializes a mutable model graph into YAML content and replaces the model section in existing content.
static List<String>	sortLookupActionIds(Collection<String> ids)	Orders lookup action ids into the canonical LOOKUP_ACTION_IDS order.
protected String	stripTrailingWhitespacePerLine(String text)
protected @Nullable DynamicAttributeAccessDefinition	toAttributeAccessDefinition(@Nullable DynamicAttributeResourceRolesModel model)
protected DynamicAttributeConstraintDefinition	toAttributeConstraintDefinition(DynamicAttributeConstraintModel model)
protected DynamicAttributeDefinition	toAttributeDefinition(String ownerEntityName, DynamicAttributeModel model)
protected @Nullable DynamicValidationDefinition<DynamicAttributeConstraintDefinition>	toAttributeValidation(List<DynamicAttributeConstraintModel> constraints)
protected @Nullable DynamicCalculatedAttributeDefinition	toCalculatedAttributeDefinition(@Nullable DynamicCalculatedAttributeModel model)
DynamicModelDefinition	toDefinition(DynamicModelDefinitionModel model)	Converts a mutable model graph into an immutable dynamic model definition.
protected @Nullable DynamicEntityAccessDefinition	toEntityAccessDefinition(@Nullable DynamicEntityResourceRolesModel model)
protected DynamicEntityConstraintDefinition	toEntityConstraintDefinition(DynamicEntityConstraintModel model)
protected DynamicEntityDefinition	toEntityDefinition(DynamicEntityModel model)
protected @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition>	toEntityValidation(List<DynamicEntityConstraintModel> constraints)
protected DynamicEnumerationDefinition	toEnumerationDefinition(DynamicEnumerationModel model)
protected DynamicEnumerationValueDefinition	toEnumerationValueDefinition(DynamicEnumerationValueModel model)
protected @Nullable List<DynamicViewHandlerDefinition>	toHandlerList(List<DynamicViewHandlerModel> models)
protected @Nullable LocalizedValue	toLocalizedValue(@Nullable DynamicLocalizedValueModel model)
protected @Nullable DynamicLookupFieldDefinition	toLookupDefinition(DynamicAttributeModel model)
protected @Nullable DynamicMenuAccessDefinition	toMenuAccessDefinition(List<DynamicStringValueModel> roleCodes)
protected @Nullable MenuItemDefinition	toMenuItemDefinition(@Nullable DynamicMenuItemModel model)
protected @Nullable Map<String,String>	toMessageMap(List<DynamicLocalizedMessageModel> messages)
protected @Nullable Map<String,Object>	toNullableObjectMap(List<DynamicKeyValueModel> values)
Map<String,Object>	toObjectMap(List<DynamicKeyValueModel> values)	Converts key-value model rows to a plain object map.
protected List<String>	toStringList(List<DynamicStringValueModel> values)
protected DynamicUniqueConstraintDefinition	toUniqueConstraintDefinition(DynamicUniqueConstraintModel model)
protected @Nullable DynamicViewAccessDefinition	toViewAccessDefinition(List<DynamicStringValueModel> roleCodes)
protected DynamicViewDefinition	toViewDefinition(DynamicViewModel model)
protected @Nullable DynamicViewDescriptorDefinition	toViewDescriptorDefinition(@Nullable DynamicViewDescriptorModel model)
protected String	writeYamlFragment(@Nullable Object value)

Methods inherited from class java.lang.Object

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

Field Details

yamlMapper

protected final com.fasterxml.jackson.databind.ObjectMapper yamlMapper

metadata

@Autowired
protected Metadata metadata

classManager

@Autowired
protected ClassManager classManager

serializer

@Autowired
protected DynamicModelDefinitionSerializer serializer

LOOKUP_ACTION_IDS

public static final List<String> LOOKUP_ACTION_IDS

Canonical order of lookup picker actions as written to YAML and offered in the settings UI.

Constructor Details

DynamicModelDefinitionModelConverter

public DynamicModelDefinitionModelConverter()

Method Details

deserialize

public DynamicModelDefinitionModel deserialize(String content)

Deserializes YAML content into a mutable model graph.

Parameters:

content - YAML content compatible with DynamicModelDefinitionSerializer

Returns:

root Model entity for UI editing

serialize

public String serialize(DynamicModelDefinitionModel model)

Serializes a mutable model graph into YAML content.

Parameters:

model - root Model entity

Returns:

YAML content compatible with DynamicModelDefinitionSerializer

serialize

public String serialize(DynamicModelDefinitionModel model,
 @Nullable String existingContent)

Serializes a mutable model graph into YAML content and replaces the model section in existing content.

Parameters:

model - root Model entity

existingContent - existing YAML content, or null

Returns:

YAML content compatible with DynamicModelDefinitionSerializer

fromDefinition

public DynamicModelDefinitionModel fromDefinition(DynamicModelDefinition definition)

Converts an immutable dynamic model definition into a mutable model graph.

Parameters:

definition - dynamic model definition

Returns:

root Model entity for UI editing

toDefinition

public DynamicModelDefinition toDefinition(DynamicModelDefinitionModel model)

Converts a mutable model graph into an immutable dynamic model definition.

Parameters:

model - root Model entity

Returns:

dynamic model definition

fromEnumerationDefinition

protected DynamicEnumerationModel fromEnumerationDefinition(DynamicEnumerationDefinition definition)

toEnumerationDefinition

protected DynamicEnumerationDefinition toEnumerationDefinition(DynamicEnumerationModel model)

fromEnumerationValueDefinition

protected DynamicEnumerationValueModel fromEnumerationValueDefinition(DynamicEnumerationValueDefinition definition)

toEnumerationValueDefinition

protected DynamicEnumerationValueDefinition toEnumerationValueDefinition(DynamicEnumerationValueModel model)

fromEntityDefinition

protected DynamicEntityModel fromEntityDefinition(DynamicEntityDefinition definition)

keepFirstInstanceNameFlag

protected void keepFirstInstanceNameFlag(List<DynamicAttributeModel> attributes)

Clears the instance-name flag on every attribute after the first flagged one. An entity has one instance-name attribute, and applying a definition with several flags uses the first one, so the editor shows the flag only where it has an effect.

toEntityDefinition

protected DynamicEntityDefinition toEntityDefinition(DynamicEntityModel model)

fromAttributeDefinition

protected DynamicAttributeModel fromAttributeDefinition(DynamicAttributeDefinition definition)

toAttributeDefinition

protected DynamicAttributeDefinition toAttributeDefinition(String ownerEntityName,
 DynamicAttributeModel model)

toLookupDefinition

protected @Nullable DynamicLookupFieldDefinition toLookupDefinition(DynamicAttributeModel model)

sortLookupActionIds

public static List<String> sortLookupActionIds(Collection<String> ids)

Orders lookup action ids into the canonical LOOKUP_ACTION_IDS order. Unknown ids (not in the canonical list) are kept and appended after the known ones in their original order.

fromCalculatedAttributeDefinition

protected @Nullable DynamicCalculatedAttributeModel fromCalculatedAttributeDefinition(@Nullable DynamicCalculatedAttributeDefinition definition)

toCalculatedAttributeDefinition

protected @Nullable DynamicCalculatedAttributeDefinition toCalculatedAttributeDefinition(@Nullable DynamicCalculatedAttributeModel model)

fromUniqueConstraintDefinition

protected DynamicUniqueConstraintModel fromUniqueConstraintDefinition(DynamicUniqueConstraintDefinition definition)

toUniqueConstraintDefinition

protected DynamicUniqueConstraintDefinition toUniqueConstraintDefinition(DynamicUniqueConstraintModel model)

fromViewDefinition

protected DynamicViewModel fromViewDefinition(DynamicViewDefinition definition)

toViewDefinition

protected DynamicViewDefinition toViewDefinition(DynamicViewModel model)

fromHandlerList

protected List<DynamicViewHandlerModel> fromHandlerList(@Nullable List<DynamicViewHandlerDefinition> handlers)

toHandlerList

protected @Nullable List<DynamicViewHandlerDefinition> toHandlerList(List<DynamicViewHandlerModel> models)

fromMenuItemDefinition

protected @Nullable DynamicMenuItemModel fromMenuItemDefinition(@Nullable MenuItemDefinition definition)

toMenuItemDefinition

protected @Nullable MenuItemDefinition toMenuItemDefinition(@Nullable DynamicMenuItemModel model)

fromViewDescriptorDefinition

protected @Nullable DynamicViewDescriptorModel fromViewDescriptorDefinition(@Nullable DynamicViewDescriptorDefinition definition)

toViewDescriptorDefinition

protected @Nullable DynamicViewDescriptorDefinition toViewDescriptorDefinition(@Nullable DynamicViewDescriptorModel model)

stripTrailingWhitespacePerLine

protected String stripTrailingWhitespacePerLine(String text)

fromEntityAccessDefinition

protected @Nullable DynamicEntityResourceRolesModel fromEntityAccessDefinition(@Nullable DynamicEntityAccessDefinition definition)

toEntityAccessDefinition

protected @Nullable DynamicEntityAccessDefinition toEntityAccessDefinition(@Nullable DynamicEntityResourceRolesModel model)

fromAttributeAccessDefinition

protected @Nullable DynamicAttributeResourceRolesModel fromAttributeAccessDefinition(@Nullable DynamicAttributeAccessDefinition definition)

toAttributeAccessDefinition

protected @Nullable DynamicAttributeAccessDefinition toAttributeAccessDefinition(@Nullable DynamicAttributeResourceRolesModel model)

fromViewAccessDefinition

protected List<DynamicStringValueModel> fromViewAccessDefinition(@Nullable DynamicViewAccessDefinition definition)

toViewAccessDefinition

protected @Nullable DynamicViewAccessDefinition toViewAccessDefinition(List<DynamicStringValueModel> roleCodes)

fromMenuAccessDefinition

protected List<DynamicStringValueModel> fromMenuAccessDefinition(@Nullable DynamicMenuAccessDefinition definition)

toMenuAccessDefinition

protected @Nullable DynamicMenuAccessDefinition toMenuAccessDefinition(List<DynamicStringValueModel> roleCodes)

fromAttributeValidation

protected List<DynamicAttributeConstraintModel> fromAttributeValidation(@Nullable DynamicValidationDefinition<DynamicAttributeConstraintDefinition> validation)

toAttributeValidation

protected @Nullable DynamicValidationDefinition<DynamicAttributeConstraintDefinition> toAttributeValidation(List<DynamicAttributeConstraintModel> constraints)

fromAttributeConstraintDefinition

protected DynamicAttributeConstraintModel fromAttributeConstraintDefinition(DynamicAttributeConstraintDefinition definition)

toAttributeConstraintDefinition

protected DynamicAttributeConstraintDefinition toAttributeConstraintDefinition(DynamicAttributeConstraintModel model)

fromEntityValidation

protected List<DynamicEntityConstraintModel> fromEntityValidation(@Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation)

toEntityValidation

protected @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> toEntityValidation(List<DynamicEntityConstraintModel> constraints)

fromEntityConstraintDefinition

protected DynamicEntityConstraintModel fromEntityConstraintDefinition(DynamicEntityConstraintDefinition definition)

toEntityConstraintDefinition

protected DynamicEntityConstraintDefinition toEntityConstraintDefinition(DynamicEntityConstraintModel model)

fromLocalizedValue

protected @Nullable DynamicLocalizedValueModel fromLocalizedValue(@Nullable LocalizedValue value)

toLocalizedValue

protected @Nullable LocalizedValue toLocalizedValue(@Nullable DynamicLocalizedValueModel model)

fromMessageMap

protected List<DynamicLocalizedMessageModel> fromMessageMap(@Nullable Map<String,String> messages)

toMessageMap

protected @Nullable Map<String,String> toMessageMap(List<DynamicLocalizedMessageModel> messages)

fromObjectMap

protected List<DynamicKeyValueModel> fromObjectMap(@Nullable Map<String,Object> values)

toObjectMap

public Map<String,Object> toObjectMap(List<DynamicKeyValueModel> values)

Converts key-value model rows to a plain object map. Public so callers that need the map form of templateParams outside conversion — for example when rendering a template preview — can reuse the same YAML value semantics.

toNullableObjectMap

protected @Nullable Map<String,Object> toNullableObjectMap(List<DynamicKeyValueModel> values)

fromStringList

protected List<DynamicStringValueModel> fromStringList(List<String> values)

toStringList

protected List<String> toStringList(List<DynamicStringValueModel> values)

loadClassOrNull

protected @Nullable Class<?> loadClassOrNull(@Nullable String attributeName,
 @Nullable String className)

Loads a class named in the graphical model. A name that does not resolve is a mistake the user has to fix in the editor, so it is reported the same way the YAML side reports it, naming the attribute and the value, instead of the class loader's own message.

writeYamlFragment

protected String writeYamlFragment(@Nullable Object value)

readYamlFragment

protected @Nullable Object readYamlFragment(@Nullable String valueYaml)

create

protected <T> T create(Class<T> entityClass)

emptyIfNull

protected String emptyIfNull(@Nullable String value)

blankToNull

protected @Nullable String blankToNull(@Nullable String value)

isBlank

protected boolean isBlank(@Nullable String value)

isTrue

protected boolean isTrue(@Nullable Boolean value)