Package io.jmix.dynmodelflowui.impl

Class DynamicViewExtensionGenerator

java.lang.Object

io.jmix.dynmodelflowui.impl.DynamicViewExtensionGenerator

@Component("dynmod_DynamicViewExtensionGenerator")
public class DynamicViewExtensionGenerator
extends Object

Generates a <view extends="…"> extension XML that adds a static entity's dynamic attributes to an existing view, targeting the dataGrid (columns) or formLayout (components) bound to the entity's data container. Supports a fresh build and a merge that adds missing attributes and removes ones no longer in the model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DynamicViewExtensionGenerator.ExtensionResult
protected static final record	DynamicViewExtensionGenerator.FetchPlanDelta
protected static final record	DynamicViewExtensionGenerator.ResolvedView
static final record	DynamicViewExtensionGenerator.TargetRef

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseViewXmlProvider	baseViewXmlProvider
protected DynamicAttributeComponentXmlFactory	componentXmlFactory
protected static final String	DATA_GRID
protected static final String	FORM_LAYOUT
protected Metadata	metadata
protected DynamicModelPackageSupport	packageSupport
protected static final String	REFERENCE_FETCH_PLAN	Nested fetch plan used when pulling a dynamic reference into the container fetch plan.
protected static final String	VIEW_EXT_NAMESPACE_URI
protected static final String	VIEW_NAMESPACE_URI

Constructor Summary

Constructors

Constructor	Description
DynamicViewExtensionGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	addAllAbsent(List<String> target, List<String> source)
protected org.dom4j.Element	addChild(org.dom4j.Element parent, String name)
protected void	addFetchPlanProperty(org.dom4j.Element fetchPlan, String name)
protected String	basePackage(@Nullable DynamicModelDefinitionModel model)
DynamicViewExtensionGenerator.ExtensionResult	buildFresh(String extendsPath, DynamicViewExtensionGenerator.TargetRef target, List<DynamicAttributeModel> attrs, String basePackage)
DynamicViewExtensionGenerator.ExtensionResult	buildMerge(String source, DynamicViewExtensionGenerator.TargetRef target, List<DynamicAttributeModel> attrs, String basePackage)
protected @Nullable org.dom4j.Element	childByName(org.dom4j.Element parent, String name)
protected void	collectContainerIds(org.dom4j.Element element, String entityFqn, Set<String> ids)
protected Set<String>	collectProperties(@Nullable org.dom4j.Element targetElem, String kind)
protected List<org.dom4j.Element>	containerPath(org.dom4j.Element container)	Path of container elements from the <data> root (exclusive) down to container.
protected List<DynamicAttributeModel>	displayableAttributes(DynamicEntityModel entity)
protected org.dom4j.Element	ensureChild(org.dom4j.Element parent, String name)
protected org.dom4j.Element	ensureChildWithId(org.dom4j.Element parent, String name, @Nullable String id)
protected org.dom4j.Element	ensureContainerFetchPlan(org.dom4j.Element root, org.dom4j.Element baseContainer)
protected org.dom4j.Element	ensureDataElement(org.dom4j.Element root)	Ensures <data> is the first child of the view so it precedes <layout>.
protected Set<String>	fetchPlanPropertyNames(@Nullable org.dom4j.Element fetchPlan)
protected @Nullable org.dom4j.Element	findBound(org.dom4j.Element element, String name, Set<String> containerIds)
protected @Nullable org.dom4j.Element	findById(org.dom4j.Element element, @Nullable String id)
protected @Nullable org.dom4j.Element	findByNameAndId(org.dom4j.Element element, String name, @Nullable String id)
protected @Nullable org.dom4j.Element	findChildWithId(org.dom4j.Element parent, String name, @Nullable String id)
protected @Nullable org.dom4j.Element	findContainerFetchPlan(org.dom4j.Element root, org.dom4j.Element baseContainer)
DynamicViewExtensionGenerator.ExtensionResult	generate(@Nullable DynamicModelDefinitionModel model, @Nullable String viewId, DynamicEntityModel entity)
DynamicViewExtensionGenerator.ExtensionResult	merge(@Nullable DynamicModelDefinitionModel model, String source, @Nullable String viewId, DynamicEntityModel entity)
protected void	pruneEmptyUpwards(@Nullable org.dom4j.Element element)	Detaches an element and its ancestors while they have no child elements, stopping at the view.
protected DynamicViewExtensionGenerator.FetchPlanDelta	reconcileReferenceFetchPlan(org.dom4j.Element root, DynamicViewExtensionGenerator.TargetRef target, List<DynamicAttributeModel> references)	Ensures the container fetch plan in root contains a <property> for each reference attribute and drops the ones no longer in the model, preserving properties already present in the base view's container fetch plan.
protected List<DynamicAttributeModel>	referenceAttributes(List<DynamicAttributeModel> attrs)
protected @Nullable String	resolveEntityFqn(DynamicEntityModel entity)
protected @Nullable String	resolveReferencedEntityClass(DynamicAttributeModel attribute, String basePackage)	Resolves the class name a reference attribute points to, or null for a non-reference attribute.
@Nullable DynamicViewExtensionGenerator.TargetRef	resolveTarget(org.dom4j.Element baseRoot, @Nullable String entityFqn)
protected DynamicViewExtensionGenerator.ResolvedView	resolveView(@Nullable String viewId, DynamicEntityModel entity)
protected String	writeXml(org.dom4j.Document document)

Methods inherited from class java.lang.Object

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

Field Details

VIEW_NAMESPACE_URI

protected static final String VIEW_NAMESPACE_URI

See Also:

• Constant Field Values

VIEW_EXT_NAMESPACE_URI

protected static final String VIEW_EXT_NAMESPACE_URI

See Also:

• Constant Field Values

DATA_GRID

protected static final String DATA_GRID

See Also:

• Constant Field Values

FORM_LAYOUT

protected static final String FORM_LAYOUT

See Also:

• Constant Field Values

REFERENCE_FETCH_PLAN

protected static final String REFERENCE_FETCH_PLAN

Nested fetch plan used when pulling a dynamic reference into the container fetch plan.

See Also:

• Constant Field Values

baseViewXmlProvider

@Autowired
protected BaseViewXmlProvider baseViewXmlProvider

metadata

@Autowired
protected Metadata metadata

componentXmlFactory

@Autowired
protected DynamicAttributeComponentXmlFactory componentXmlFactory

packageSupport

@Autowired
protected DynamicModelPackageSupport packageSupport

Constructor Details

DynamicViewExtensionGenerator

public DynamicViewExtensionGenerator()

Method Details

generate

public DynamicViewExtensionGenerator.ExtensionResult generate(@Nullable DynamicModelDefinitionModel model,
 @Nullable String viewId,
 DynamicEntityModel entity)

merge

public DynamicViewExtensionGenerator.ExtensionResult merge(@Nullable DynamicModelDefinitionModel model,
 String source,
 @Nullable String viewId,
 DynamicEntityModel entity)

basePackage

protected String basePackage(@Nullable DynamicModelDefinitionModel model)

resolveReferencedEntityClass

protected @Nullable String resolveReferencedEntityClass(DynamicAttributeModel attribute,
 String basePackage)

Resolves the class name a reference attribute points to, or null for a non-reference attribute. A dynamic entity that is not applied yet has no metadata, so the name it gets on apply is used.

resolveView

protected DynamicViewExtensionGenerator.ResolvedView resolveView(@Nullable String viewId,
 DynamicEntityModel entity)

resolveEntityFqn

protected @Nullable String resolveEntityFqn(DynamicEntityModel entity)

displayableAttributes

protected List<DynamicAttributeModel> displayableAttributes(DynamicEntityModel entity)

resolveTarget

public @Nullable DynamicViewExtensionGenerator.TargetRef resolveTarget(org.dom4j.Element baseRoot,
 @Nullable String entityFqn)

buildFresh

public DynamicViewExtensionGenerator.ExtensionResult buildFresh(String extendsPath,
 DynamicViewExtensionGenerator.TargetRef target,
 List<DynamicAttributeModel> attrs,
 String basePackage)

buildMerge

public DynamicViewExtensionGenerator.ExtensionResult buildMerge(String source,
 DynamicViewExtensionGenerator.TargetRef target,
 List<DynamicAttributeModel> attrs,
 String basePackage)

addAllAbsent

protected void addAllAbsent(List<String> target,
 List<String> source)

childByName

protected @Nullable org.dom4j.Element childByName(org.dom4j.Element parent,
 String name)

findByNameAndId

protected @Nullable org.dom4j.Element findByNameAndId(org.dom4j.Element element,
 String name,
 @Nullable String id)

ensureChild

protected org.dom4j.Element ensureChild(org.dom4j.Element parent,
 String name)

collectProperties

protected Set<String> collectProperties(@Nullable org.dom4j.Element targetElem,
 String kind)

referenceAttributes

protected List<DynamicAttributeModel> referenceAttributes(List<DynamicAttributeModel> attrs)

reconcileReferenceFetchPlan

protected DynamicViewExtensionGenerator.FetchPlanDelta reconcileReferenceFetchPlan(org.dom4j.Element root,
 DynamicViewExtensionGenerator.TargetRef target,
 List<DynamicAttributeModel> references)

Ensures the container fetch plan in root contains a <property> for each reference attribute and drops the ones no longer in the model, preserving properties already present in the base view's container fetch plan. No-op when there is nothing to add and no existing fetch plan to clean.

pruneEmptyUpwards

protected void pruneEmptyUpwards(@Nullable org.dom4j.Element element)

Detaches an element and its ancestors while they have no child elements, stopping at the view.

addFetchPlanProperty

protected void addFetchPlanProperty(org.dom4j.Element fetchPlan,
 String name)

fetchPlanPropertyNames

protected Set<String> fetchPlanPropertyNames(@Nullable org.dom4j.Element fetchPlan)

findContainerFetchPlan

protected @Nullable org.dom4j.Element findContainerFetchPlan(org.dom4j.Element root,
 org.dom4j.Element baseContainer)

ensureContainerFetchPlan

protected org.dom4j.Element ensureContainerFetchPlan(org.dom4j.Element root,
 org.dom4j.Element baseContainer)

containerPath

protected List<org.dom4j.Element> containerPath(org.dom4j.Element container)

Path of container elements from the <data> root (exclusive) down to container.

ensureDataElement

protected org.dom4j.Element ensureDataElement(org.dom4j.Element root)

Ensures <data> is the first child of the view so it precedes <layout>.

findChildWithId

protected @Nullable org.dom4j.Element findChildWithId(org.dom4j.Element parent,
 String name,
 @Nullable String id)

ensureChildWithId

protected org.dom4j.Element ensureChildWithId(org.dom4j.Element parent,
 String name,
 @Nullable String id)

findById

protected @Nullable org.dom4j.Element findById(org.dom4j.Element element,
 @Nullable String id)

collectContainerIds

protected void collectContainerIds(org.dom4j.Element element,
 String entityFqn,
 Set<String> ids)

findBound

protected @Nullable org.dom4j.Element findBound(org.dom4j.Element element,
 String name,
 Set<String> containerIds)

addChild

protected org.dom4j.Element addChild(org.dom4j.Element parent,
 String name)

writeXml

protected String writeXml(org.dom4j.Document document)