Package io.jmix.dynmodel.meta

Class DynamicModelDefinitions

java.lang.Object

io.jmix.dynmodel.meta.DynamicModelDefinitions

public final class DynamicModelDefinitions
extends Object

Static utility methods for creating dynamic model definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DynamicModelDefinitions.AttributeBuilder
static final class	DynamicModelDefinitions.ViewBuilder

Method Summary

Modifier and Type	Method	Description
static DynamicModelDefinitions.AttributeBuilder	attribute(String name)
static DynamicAttributeConstraintDefinition	attributeConstraint(String annotation)	Creates an attribute constraint definition without parameters or groups.
static DynamicValidationDefinition<DynamicAttributeConstraintDefinition>	attributeValidation(DynamicAttributeConstraintDefinition... constraints)	Creates an attribute validation definition.
static DynamicAttributeDefinition	basicAttr(String name, Class<?> javaClass)
static DynamicAttributeDefinition	calculatedAttr(String name, Class<?> javaClass, String expression, String... dependsOn)
static DynamicAttributeDefinition	collectionAttr(String name, String entityName)
static DynamicViewDescriptorDefinition	descriptor(@Nullable String template, @Nullable String source)
static DynamicModelDefinitions.ViewBuilder	detailView()
static DynamicEntityDefinition	entity(String entityName, DynamicAttributeDefinition... attributes)
static DynamicEntityDefinition	entity(String entityName, List<DynamicAttributeDefinition> attributes)
static DynamicEntityDefinition	entity(String entityName, List<DynamicAttributeDefinition> attributes, @Nullable Map<String,String> messages)
static DynamicEntityDefinition	entity(String entityName, List<DynamicAttributeDefinition> attributes, List<DynamicUniqueConstraintDefinition> uniqueConstraints, List<DynamicViewDefinition> views, @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation, @Nullable Map<String,String> messages)	Creates a dynamic entity definition with unique and validation metadata.
static DynamicEntityDefinition	entity(String entityName, List<DynamicAttributeDefinition> attributes, List<DynamicUniqueConstraintDefinition> uniqueConstraints, List<DynamicViewDefinition> views, @Nullable Map<String,String> messages)	Creates a dynamic entity definition with unique constraints.
static DynamicEntityDefinition	entity(String entityName, List<DynamicAttributeDefinition> attributes, List<DynamicViewDefinition> views)
static DynamicEntityDefinition	entity(String entityName, List<DynamicAttributeDefinition> attributes, List<DynamicViewDefinition> views, @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation, @Nullable Map<String,String> messages)	Creates a dynamic entity definition with validation metadata.
static DynamicEntityDefinition	entity(String entityName, List<DynamicAttributeDefinition> attributes, List<DynamicViewDefinition> views, @Nullable Map<String,String> messages)
static DynamicEntityDefinition	entityInStore(String entityName, String store, DynamicAttributeDefinition... attributes)
static DynamicValidationDefinition<DynamicEntityConstraintDefinition>	entityValidation(DynamicEntityConstraintDefinition... constraints)	Creates an entity validation definition.
static DynamicEntityDefinition	entityWithViews(String entityName, DynamicViewDefinition... views)
static DynamicAttributeDefinition	enumAttr(String name, String enumeration)
static DynamicEntityConstraintDefinition	expressionConstraint(String name, String expression, String... attributes)	Creates an entity expression constraint definition.
static DynamicModelDefinitions.ViewBuilder	listView()
static LocalizedValue	localized(String value)
static LocalizedValue	localized(Map<String,String> values)
static MenuItemDefinition	menu(String parentMenu)
static MenuItemDefinition	menu(String parentMenu, LocalizedValue title)
static MenuItemDefinition	menu(String parentMenu, LocalizedValue title, @Nullable DynamicMenuAccessDefinition resourceRoles)	Creates a dynamic menu item definition with resource-role grants.
static DynamicMenuAccessDefinition	menuResourceRoles(List<String> roleCodes)	Creates dynamic menu resource-role grants.
static DynamicModelDefinition	model(String basePackage, DynamicEntityDefinition... entities)
static DynamicModelDefinition	model(String basePackage, List<DynamicEntityDefinition> entities)
static DynamicModelDefinition	model(String basePackage, List<DynamicEnumerationDefinition> enumerations, List<DynamicEntityDefinition> entities)
static DynamicAttributeDefinition	refAttr(String name, String entityName)
static DynamicViewAccessDefinition	resourceRoles(List<String> roleCodes)	Creates dynamic view resource-role grants.
static DynamicAttributeAccessDefinition	resourceRoles(List<String> view, List<String> modify)	Creates dynamic attribute resource-role grants.
static DynamicEntityAccessDefinition	resourceRoles(List<String> read, List<String> create, List<String> update, List<String> delete)	Creates dynamic entity resource-role grants.
static DynamicAttributeDefinition	stringAttr(String name, int length)
static DynamicAttributeDefinition	stringLobAttr(String name)
static DynamicUniqueConstraintDefinition	uniqueConstraint(String name, LocalizedValue message, String... attributes)	Creates a unique constraint definition.
static DynamicUniqueConstraintDefinition	uniqueConstraint(String name, String... attributes)	Creates a unique constraint definition without a custom message.
static DynamicModelDefinitions.ViewBuilder	view(@Nullable DynamicViewType type)

Methods inherited from class java.lang.Object

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

Method Details

model

public static DynamicModelDefinition model(String basePackage,
 DynamicEntityDefinition... entities)

model

public static DynamicModelDefinition model(String basePackage,
 List<DynamicEntityDefinition> entities)

model

public static DynamicModelDefinition model(String basePackage,
 List<DynamicEnumerationDefinition> enumerations,
 List<DynamicEntityDefinition> entities)

entity

public static DynamicEntityDefinition entity(String entityName,
 DynamicAttributeDefinition... attributes)

entity

public static DynamicEntityDefinition entity(String entityName,
 List<DynamicAttributeDefinition> attributes)

entity

public static DynamicEntityDefinition entity(String entityName,
 List<DynamicAttributeDefinition> attributes,
 List<DynamicViewDefinition> views)

entity

public static DynamicEntityDefinition entity(String entityName,
 List<DynamicAttributeDefinition> attributes,
 List<DynamicViewDefinition> views,
 @Nullable Map<String,String> messages)

entity

public static DynamicEntityDefinition entity(String entityName,
 List<DynamicAttributeDefinition> attributes,
 List<DynamicUniqueConstraintDefinition> uniqueConstraints,
 List<DynamicViewDefinition> views,
 @Nullable Map<String,String> messages)

Creates a dynamic entity definition with unique constraints.

Parameters:

entityName - entity name

attributes - entity attributes

uniqueConstraints - entity unique constraints

views - entity-owned dynamic views

messages - localized entity captions

Returns:

dynamic entity definition

entity

public static DynamicEntityDefinition entity(String entityName,
 List<DynamicAttributeDefinition> attributes,
 List<DynamicViewDefinition> views,
 @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation,
 @Nullable Map<String,String> messages)

Creates a dynamic entity definition with validation metadata.

Parameters:

entityName - entity name

attributes - entity attributes

views - entity-owned dynamic views

validation - entity validation definition

messages - localized entity captions

Returns:

dynamic entity definition

entity

public static DynamicEntityDefinition entity(String entityName,
 List<DynamicAttributeDefinition> attributes,
 List<DynamicUniqueConstraintDefinition> uniqueConstraints,
 List<DynamicViewDefinition> views,
 @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation,
 @Nullable Map<String,String> messages)

Creates a dynamic entity definition with unique and validation metadata.

Parameters:

entityName - entity name

attributes - entity attributes

uniqueConstraints - entity unique constraints

views - entity-owned dynamic views

validation - entity validation definition

messages - localized entity captions

Returns:

dynamic entity definition

entity

public static DynamicEntityDefinition entity(String entityName,
 List<DynamicAttributeDefinition> attributes,
 @Nullable Map<String,String> messages)

entityWithViews

public static DynamicEntityDefinition entityWithViews(String entityName,
 DynamicViewDefinition... views)

entityInStore

public static DynamicEntityDefinition entityInStore(String entityName,
 String store,
 DynamicAttributeDefinition... attributes)

localized

public static LocalizedValue localized(String value)

localized

public static LocalizedValue localized(Map<String,String> values)

menu

public static MenuItemDefinition menu(String parentMenu)

menu

public static MenuItemDefinition menu(String parentMenu,
 LocalizedValue title)

menu

public static MenuItemDefinition menu(String parentMenu,
 LocalizedValue title,
 @Nullable DynamicMenuAccessDefinition resourceRoles)

Creates a dynamic menu item definition with resource-role grants.

Parameters:

parentMenu - parent menu identifier

title - menu title

resourceRoles - menu role grants

Returns:

menu item definition

descriptor

public static DynamicViewDescriptorDefinition descriptor(@Nullable String template,
 @Nullable String source)

basicAttr

public static DynamicAttributeDefinition basicAttr(String name,
 Class<?> javaClass)

stringAttr

public static DynamicAttributeDefinition stringAttr(String name,
 int length)

stringLobAttr

public static DynamicAttributeDefinition stringLobAttr(String name)

refAttr

public static DynamicAttributeDefinition refAttr(String name,
 String entityName)

collectionAttr

public static DynamicAttributeDefinition collectionAttr(String name,
 String entityName)

enumAttr

public static DynamicAttributeDefinition enumAttr(String name,
 String enumeration)

calculatedAttr

public static DynamicAttributeDefinition calculatedAttr(String name,
 Class<?> javaClass,
 String expression,
 String... dependsOn)

resourceRoles

public static DynamicEntityAccessDefinition resourceRoles(List<String> read,
 List<String> create,
 List<String> update,
 List<String> delete)

Creates dynamic entity resource-role grants.

Parameters:

read - role codes that can read the entity

create - role codes that can create the entity

update - role codes that can update the entity

delete - role codes that can delete the entity

Returns:

entity access definition

resourceRoles

public static DynamicAttributeAccessDefinition resourceRoles(List<String> view,
 List<String> modify)

Creates dynamic attribute resource-role grants.

Parameters:

view - role codes that can view the attribute

modify - role codes that can modify the attribute

Returns:

attribute access definition

resourceRoles

public static DynamicViewAccessDefinition resourceRoles(List<String> roleCodes)

Creates dynamic view resource-role grants.

Parameters:

roleCodes - role codes that can open the view

Returns:

view access definition

menuResourceRoles

public static DynamicMenuAccessDefinition menuResourceRoles(List<String> roleCodes)

Creates dynamic menu resource-role grants.

Parameters:

roleCodes - role codes that can access the menu item

Returns:

menu access definition

attribute

public static DynamicModelDefinitions.AttributeBuilder attribute(String name)

attributeValidation

@SafeVarargs
public static DynamicValidationDefinition<DynamicAttributeConstraintDefinition> attributeValidation(DynamicAttributeConstraintDefinition... constraints)

Creates an attribute validation definition.

Parameters:

constraints - attribute constraints

Returns:

validation definition

entityValidation

@SafeVarargs
public static DynamicValidationDefinition<DynamicEntityConstraintDefinition> entityValidation(DynamicEntityConstraintDefinition... constraints)

Creates an entity validation definition.

Parameters:

constraints - entity constraints

Returns:

validation definition

attributeConstraint

public static DynamicAttributeConstraintDefinition attributeConstraint(String annotation)

Creates an attribute constraint definition without parameters or groups.

Parameters:

annotation - constraint annotation alias

Returns:

attribute constraint definition

expressionConstraint

public static DynamicEntityConstraintDefinition expressionConstraint(String name,
 String expression,
 String... attributes)

Creates an entity expression constraint definition.

Parameters:

name - constraint name

expression - validation expression

attributes - attributes participating in validation

Returns:

entity constraint definition

uniqueConstraint

public static DynamicUniqueConstraintDefinition uniqueConstraint(String name,
 String... attributes)

Creates a unique constraint definition without a custom message.

Parameters:

name - constraint name

attributes - participating attribute names

Returns:

unique constraint definition

uniqueConstraint

public static DynamicUniqueConstraintDefinition uniqueConstraint(String name,
 LocalizedValue message,
 String... attributes)

Creates a unique constraint definition.

Parameters:

name - constraint name

message - violation message

attributes - participating attribute names

Returns:

unique constraint definition

view

public static DynamicModelDefinitions.ViewBuilder view(@Nullable DynamicViewType type)

listView

public static DynamicModelDefinitions.ViewBuilder listView()

detailView

public static DynamicModelDefinitions.ViewBuilder detailView()