Package io.jmix.dynmodelai.modelchange.impl

Class DynamicModelAttributeOperations

java.lang.Object

io.jmix.dynmodelai.modelchange.impl.DynamicModelAttributeOperations

@Component("dmagent_DynamicModelAttributeOperations")
public class DynamicModelAttributeOperations
extends Object

Operations that edit attributes and references of the target Dynamic Model entity.

Field Summary

Fields

Modifier and Type	Field	Description
protected final CoreProperties	coreProperties
protected final CurrentAuthentication	currentAuthentication
protected final DynamicModelTools	dynamicModelTools
protected final Messages	messages
protected final Metadata	metadata

Constructor Summary

Constructors

Constructor	Description
DynamicModelAttributeOperations(CurrentAuthentication currentAuthentication, CoreProperties coreProperties, Metadata metadata, DynamicModelTools dynamicModelTools, Messages messages)

Method Summary

Modifier and Type	Method	Description
MutationResult	addAttribute(DynamicModelDefinition definition, String entityName, DynamicModelDefinition baseline, @Nullable DynamicAttributeDefinition previous, String name, AttributeType type, @Nullable Caption caption, @Nullable Boolean required, @Nullable Integer length, @Nullable Boolean displayName, @Nullable Boolean unique)
MutationResult	addReference(DynamicModelDefinition definition, String entityName, DynamicModelDefinition baseline, @Nullable DynamicAttributeDefinition previous, String name, String targetEntity, @Nullable Caption caption, @Nullable Boolean required, @Nullable Boolean collection)
protected String	captionLocale()	The message key of the analyst's language among the application locales: a key with a country, such as en_US, must be written as such, or the old text under it would stay visible.
protected @Nullable MutationIssue	captionLocaleIssue(@Nullable Caption caption)	A caption may use only the application's locales: other texts would never be shown.
protected Map<String,String>	captionMessages(@Nullable Caption caption, String name)	Captions by locale.
protected MutationResult	failed(String code, String messageKey, Object... arguments)
protected MutationIssue	issue(String code, String messageKey, Object... arguments)	An issue whose guidance has the key of its message followed by Guidance.
MutationResult	moveAttribute(DynamicModelDefinition definition, String entityName, String name, @Nullable String before)
MutationResult	removeAttribute(DynamicModelDefinition definition, String entityName, String attributeName)
MutationResult	reorderAttributes(DynamicModelDefinition definition, String entityName, List<String> attributeNames)
protected MutationIssue	unknownEntity(String entityName, DynamicModelDefinition definition)
MutationResult	updateAttributeCaption(DynamicModelDefinition definition, String entityName, String name, Caption caption)

Methods inherited from class java.lang.Object

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

Field Details

metadata

protected final Metadata metadata

dynamicModelTools

protected final DynamicModelTools dynamicModelTools

currentAuthentication

protected final CurrentAuthentication currentAuthentication

coreProperties

protected final CoreProperties coreProperties

messages

protected final Messages messages

Constructor Details

DynamicModelAttributeOperations

public DynamicModelAttributeOperations(CurrentAuthentication currentAuthentication,
 CoreProperties coreProperties,
 Metadata metadata,
 DynamicModelTools dynamicModelTools,
 Messages messages)

Method Details

addAttribute

public MutationResult addAttribute(DynamicModelDefinition definition,
 String entityName,
 DynamicModelDefinition baseline,
 @Nullable DynamicAttributeDefinition previous,
 String name,
 AttributeType type,
 @Nullable Caption caption,
 @Nullable Boolean required,
 @Nullable Integer length,
 @Nullable Boolean displayName,
 @Nullable Boolean unique)

removeAttribute

public MutationResult removeAttribute(DynamicModelDefinition definition,
 String entityName,
 String attributeName)

reorderAttributes

public MutationResult reorderAttributes(DynamicModelDefinition definition,
 String entityName,
 List<String> attributeNames)

moveAttribute

public MutationResult moveAttribute(DynamicModelDefinition definition,
 String entityName,
 String name,
 @Nullable String before)

updateAttributeCaption

public MutationResult updateAttributeCaption(DynamicModelDefinition definition,
 String entityName,
 String name,
 Caption caption)

addReference

public MutationResult addReference(DynamicModelDefinition definition,
 String entityName,
 DynamicModelDefinition baseline,
 @Nullable DynamicAttributeDefinition previous,
 String name,
 String targetEntity,
 @Nullable Caption caption,
 @Nullable Boolean required,
 @Nullable Boolean collection)

issue

protected MutationIssue issue(String code,
 String messageKey,
 Object... arguments)

An issue whose guidance has the key of its message followed by Guidance.

failed

protected MutationResult failed(String code,
 String messageKey,
 Object... arguments)

captionMessages

protected Map<String,String> captionMessages(@Nullable Caption caption,
 String name)

Captions by locale. A text without a locale belongs to the language the analyst works in: the current user locale, falling back to the first available locale. A caption derived from the name is the only text there is, so every application locale gets it.

captionLocaleIssue

protected @Nullable MutationIssue captionLocaleIssue(@Nullable Caption caption)

A caption may use only the application's locales: other texts would never be shown.

captionLocale

protected String captionLocale()

The message key of the analyst's language among the application locales: a key with a country, such as en_US, must be written as such, or the old text under it would stay visible.

unknownEntity

protected MutationIssue unknownEntity(String entityName,
 DynamicModelDefinition definition)