Package io.jmix.dynmodel.impl

Class DynamicModelDefinitionYamlSerializer

java.lang.Object

io.jmix.dynmodel.impl.DynamicModelDefinitionYamlSerializer

All Implemented Interfaces:

DynamicModelDefinitionSerializer

@NullMarked
@Component("dynmod_DynamicModelDefinitionYamlSerializer")
public class DynamicModelDefinitionYamlSerializer
extends Object
implements DynamicModelDefinitionSerializer

Serializes and deserializes dynamic model definitions in YAML format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	DynamicModelDefinitionYamlSerializer.DefinitionDocument	The root of the YAML content.

Field Summary

Fields

Modifier and Type	Field	Description
protected DynamicModelPackageSupport	dynamicModelPackageSupport
protected final com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor	Description
DynamicModelDefinitionYamlSerializer()

Method Summary

Modifier and Type	Method	Description
DynamicModelDefinition	deserialize(String content)
protected String	formatLocation(IOException e)	Formats the location of the failure in the content, for example line 7, column 21, or returns an empty string when it is not known.
protected String	formatPath(List<com.fasterxml.jackson.databind.JsonMappingException.Reference> references)	Formats a Jackson reference chain as a YAML path, for example entities[0].attributes[2].javaClass.
protected DynamicModelDefinitionParseException	parseException(IOException e)	Builds an exception whose message can be shown to the user: it says where in the content the problem is - the path of the rejected value in the model and, when it is known, its location in the text, or only the location for a YAML syntax error - and what is wrong with it.
protected String	reason(IOException e)	Explains the failure in one line.
protected DynamicModelDefinition	sanitizeDefinition(DynamicModelDefinition definition)
protected DynamicEntityDefinition	sanitizeEntityDefinition(DynamicEntityDefinition entityDefinition)
String	serialize(DynamicModelDefinition definition)
String	serialize(DynamicModelDefinition definition, @Nullable String existingContent)

Methods inherited from class java.lang.Object

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

Field Details

mapper

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

dynamicModelPackageSupport

@Autowired
protected DynamicModelPackageSupport dynamicModelPackageSupport

Constructor Details

DynamicModelDefinitionYamlSerializer

public DynamicModelDefinitionYamlSerializer()

Method Details

serialize

public String serialize(DynamicModelDefinition definition)

Specified by:

serialize in interface DynamicModelDefinitionSerializer

serialize

public String serialize(DynamicModelDefinition definition,
 @Nullable String existingContent)

Specified by:

serialize in interface DynamicModelDefinitionSerializer

deserialize

public DynamicModelDefinition deserialize(String content)

Specified by:

deserialize in interface DynamicModelDefinitionSerializer

parseException

protected DynamicModelDefinitionParseException parseException(IOException e)

Builds an exception whose message can be shown to the user: it says where in the content the problem is - the path of the rejected value in the model and, when it is known, its location in the text, or only the location for a YAML syntax error - and what is wrong with it.

formatPath

protected String formatPath(List<com.fasterxml.jackson.databind.JsonMappingException.Reference> references)

Formats a Jackson reference chain as a YAML path, for example entities[0].attributes[2].javaClass. The path starts inside the root model key.

formatLocation

protected String formatLocation(IOException e)

Formats the location of the failure in the content, for example line 7, column 21, or returns an empty string when it is not known.

reason

protected String reason(IOException e)

Explains the failure in one line. A class name that does not resolve is the expected case for an attribute's javaClass, and Jackson reports it only as the cause.

sanitizeDefinition

protected DynamicModelDefinition sanitizeDefinition(DynamicModelDefinition definition)

sanitizeEntityDefinition

protected DynamicEntityDefinition sanitizeEntityDefinition(DynamicEntityDefinition entityDefinition)