de.ipcon.schema.generators.coredata

Class FormularTemplate

java.lang.Object

de.ipcon.schema.generators.coredata.BOTemplate

de.ipcon.schema.generators.coredata.BenanntTemplate

de.ipcon.schema.generators.coredata.StrukturTemplate

de.ipcon.schema.generators.coredata.EntityStrukturTemplate

de.ipcon.schema.generators.coredata.FormularTemplate

public class FormularTemplate
extends EntityStrukturTemplate

This class is responsible for generating the XML UI definition for Entity Forms.

It traverses the Entity-Relationship model (EntityI/AttributeI) and constructs a layout containing Tabs, Views, and Form Elements (Text fields, ComboBoxes, Trees, etc.).

It handles:

• >Recursion depth to prevent infinite UI nesting.
• >Polymorphic entity handling.
• >Distinction between simple attributes and relations (1:1, 1:n, n-m).
• >Generation of "Virtual" vs "Stored" attribute views.

Constructor Summary

Constructors

Constructor and Description
FormularTemplate() Default constructor.
FormularTemplate(SQLCoreDataStoreI store, electric.xml.Document doc, long elterDefault, java.lang.StringBuilder sbLivelist) Constructor for testing.
FormularTemplate(SQLCoreDataStoreI store, EntityI entity, long idElter) Constructor for initialization with a specific Id.

Method Summary

Modifier and Type	Method and Description
void	appendAttributeByType(java.lang.StringBuilder sv, java.lang.StringBuilder rv, EntityI entity, EntityI mainEntity, AttributeI backAttributeToParent, java.util.Map<java.lang.String,java.lang.Integer> attributeCountByName, boolean renderTabs, boolean scrollable, boolean filterOutBOAttrs, boolean showHiddenAttrs, java.lang.Boolean filterToVirtual, boolean sort, int remainingRecursionDepth) Processes a list of attributes for a specific entity and appends the corresponding XML Elements to either the scalar view buffer (sv) or the relation view buffer (rv).
void	appendFormElementForSimpleAttribute(java.lang.StringBuilder sv, AttributeI attr, boolean needsVisibleIf) Appends the appropriate XML element for a simple (scalar) attribute.
java.lang.StringBuilder	appendPopupDetailView(java.lang.StringBuilder sv, AttributeI relationAttr, int remainingRecursionDepth) Creates a Popup component and optionally a nested DetailView for n:1 relations.
java.lang.StringBuilder	appendViewElementsForEntity(java.lang.StringBuilder sb, EntityI mainEntity, AttributeI backAttributeToParent, boolean renderTabs, boolean scrollable, boolean filterOutBOAttrs, boolean showHiddenAttrs, java.lang.Boolean filterToVirtual, boolean sort, int remainingRecursionDepth) Core method: Fills a View with Elements representing the attributes of the given entity.
java.lang.String	createStandardParameter(EntityI entity) Generates the standard XML for the Entity.
java.lang.String	getBOTName() Returns the Business Object Type name.
boolean	isPolymorphic()
void	setPolymorphic(boolean $19)

Methods inherited from class de.ipcon.schema.generators.coredata.EntityStrukturTemplate

appendFTableWithColumnsForEntity, appendFTableWithColumnsForEntity, appendOpenRelationFTableWithColumnsForEntity, createColumnsForEntity, filterAttrs, getBotyp, getDefaultName, getGruppen, getGruppen, getParameter, getPrioritaet, setBotyp, setGruppen, setGruppen, setParameter, setPrioritaet

Methods inherited from class de.ipcon.schema.generators.coredata.StrukturTemplate

getDateiname, getElter, getTid, isIstAutomatik, setDateiname, setElter, setIstAutomatik, setTid

Methods inherited from class de.ipcon.schema.generators.coredata.BenanntTemplate

getBeschreibung, getName, setBeschreibung, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

FormularTemplate

public FormularTemplate()

Default constructor.

FormularTemplate

public FormularTemplate(SQLCoreDataStoreI store,
                        EntityI entity,
                        long idElter)

Constructor for initialization with a specific Id. Sets up polymorphic behavior if the entity is abstract.

FormularTemplate

public FormularTemplate(SQLCoreDataStoreI store,
                        electric.xml.Document doc,
                        long elterDefault,
                        java.lang.StringBuilder sbLivelist)
                 throws CoredataGenerationException,
                        java.sql.SQLException

Constructor for testing.

Throws:

CoredataGenerationException

java.sql.SQLException

Method Detail

getBOTName

public java.lang.String getBOTName()

Description copied from class: BOTemplate

Returns the Business Object Type name.

Specified by:

getBOTName in class BOTemplate

createStandardParameter

public java.lang.String createStandardParameter(EntityI entity)

Generates the standard XML for the Entity.

This creates a TabbedView with three main tabs:

1. Attributes (Standard filtered view)
2. Virtual Attributes
3. All Attributes (Schema ordered)

It also determines the recursion depth for nested forms.

Specified by:

createStandardParameter in class EntityStrukturTemplate

Parameters:

entity - The root entity for which to generate the form.

Returns:

A String containing the complete XML definition.

appendViewElementsForEntity

public java.lang.StringBuilder appendViewElementsForEntity(java.lang.StringBuilder sb,
                                                           EntityI mainEntity,
                                                           AttributeI backAttributeToParent,
                                                           boolean renderTabs,
                                                           boolean scrollable,
                                                           boolean filterOutBOAttrs,
                                                           boolean showHiddenAttrs,
                                                           java.lang.Boolean filterToVirtual,
                                                           boolean sort,
                                                           int remainingRecursionDepth)

Core method: Fills a View with Elements representing the attributes of the given entity.

This method handles the distinction between scalar fields (appended to 'sv') and relations (appended to 'rv'), aggregating them based on the Entity hierarchy.

Parameters:

sb - A StringBuilder which is filled with the current content of the structure element.

mainEntity - The main entity of which the attributes are to be fetched.

backAttributeToParent - The attribute linking back to the parent (to avoid cyclic rendering).

renderTabs - Whether to embed the elements inside a Tab of a TabbedView.

scrollable - Whether the generated Tab should be scrollable.

filterOutBOAttrs - Whether the attributes of the generic "BO" entity should be filtered out.

showHiddenAttrs - Whether attributes marked as hidden are shown.

filterToVirtual - Boolean filter: true=virtual only, false=stored only, null=all.

sort - Whether to sort attributes by name or preserve Schema order. The latter option places attributes of the super-entity above the ones of the sub-entity.

remainingRecursionDepth - Remaining recursion depth. If <= 0, generation stops.

Returns:

The given StringBuilder with the attributes appended.

appendAttributeByType

public void appendAttributeByType(java.lang.StringBuilder sv,
                                  java.lang.StringBuilder rv,
                                  EntityI entity,
                                  EntityI mainEntity,
                                  AttributeI backAttributeToParent,
                                  java.util.Map<java.lang.String,java.lang.Integer> attributeCountByName,
                                  boolean renderTabs,
                                  boolean scrollable,
                                  boolean filterOutBOAttrs,
                                  boolean showHiddenAttrs,
                                  java.lang.Boolean filterToVirtual,
                                  boolean sort,
                                  int remainingRecursionDepth)

Processes a list of attributes for a specific entity and appends the corresponding XML Elements to either the scalar view buffer (sv) or the relation view buffer (rv).

Parameters:

sv - StringBuilder for Scalar values (Text fields, Checkboxes, etc).

rv - StringBuilder for Relations (Tables, Trees, Tabs).

entity - The current entity being processed.

mainEntity - The root entity.

backAttributeToParent - Attribute pointing back to parent.

attributeCountByName - Map of attribute counts for name collision detection.

renderTabs - Whether we are rendering tabs.

scrollable - Scroll setting.

filterOutBOAttrs - BO Filter setting.

showHiddenAttrs - Hidden property setting.

filterToVirtual - Virtual attribute setting.

sort - Sort setting.

remainingRecursionDepth - Remaining recursion depth. If <= 0, generation stops.

appendFormElementForSimpleAttribute

public void appendFormElementForSimpleAttribute(java.lang.StringBuilder sv,
                                                AttributeI attr,
                                                boolean needsVisibleIf)

Appends the appropriate XML element for a simple (scalar) attribute. Determines the component type (Text, CheckBox, DateChooser) based on Java Class.

Parameters:

sv - Target StringBuilder.

attr - The attribute definition.

needsVisibleIf - Whether to wrap in visibility logic.

appendPopupDetailView

public java.lang.StringBuilder appendPopupDetailView(java.lang.StringBuilder sv,
                                                     AttributeI relationAttr,
                                                     int remainingRecursionDepth)

Creates a Popup component and optionally a nested DetailView for n:1 relations.

Parameters:

sv - Target StringBuilder.

relationAttr - The relation attribute.

remainingRecursionDepth - Remaining recursion depth. If <= 0, generation stops.

Returns:

The updated StringBuilder.

isPolymorphic

public boolean isPolymorphic()

setPolymorphic

public void setPolymorphic(boolean $19)