Package org.broadleafcommerce.openadmin.web.service

Class FormBuilderServiceImpl

java.lang.Object

org.broadleafcommerce.openadmin.web.service.FormBuilderServiceImpl

All Implemented Interfaces:

FormBuilderService

@Service("blFormBuilderService")
public class FormBuilderServiceImpl
extends Object
implements FormBuilderService

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field	Description
protected AdminEntityService	adminEntityService
protected AdminNavigationService	adminNavigationService
protected SecurityVerifier	adminRemoteSecurityService
static final String	ALTERNATE_ID_PROPERTY
protected EntityDuplicator	duplicator
protected DynamicEntityDao	dynamicEntityDao
protected EntityConfiguration	entityConfiguration
protected ExploitProtectionService	exploitProtectionService
protected FormBuilderExtensionManager	extensionManager
protected static final VisibilityEnum[]	FORM_HIDDEN_VISIBILITIES
static final VisibilityEnum[]	GRID_HIDDEN_VISIBILITIES
protected boolean	htmlEscapeMainEntityLink
protected ListGridErrorMessageExtensionManager	listGridErrorExtensionManager
protected LocaleService	localeService
protected MediaBuilderService	mediaBuilderService
protected AdminNavigationService	navigationService
protected RowLevelSecurityService	rowLevelSecurityService
protected TranslationService	translationService
protected boolean	useTranslationSearch

Constructor Summary

Constructors

Constructor	Description
FormBuilderServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalFormActions(EntityForm ef)	This method is invoked when EntityForms are created and is meant to provide a hook to add additional entity form actions for implementors of Broadleaf.
protected void	addDeleteActionIfAllowed(EntityForm entityForm, ClassMetadata cmd, Entity entity)	Adds the DefaultEntityFormActions.DELETE if the user is allowed to delete the entity.
protected void	addDuplicateActionIfAllowed(EntityForm entityForm, ClassMetadata cmd)
EntityForm	buildAdornedListForm(AdornedTargetCollectionMetadata adornedMd, AdornedTargetList adornedList, String parentId, boolean isViewCollectionItem, List<SectionCrumb> sectionCrumbs, boolean isAdd)	Builds the EntityForm used in modal dialogs when adding items to adorned target collections.
EntityForm	buildAdornedListForm(AdornedTargetCollectionMetadata adornedMd, AdornedTargetList adornedList, String parentId, boolean isViewCollectionItem, EntityForm ef, List<SectionCrumb> sectionCrumbs, boolean isAdd)	Equivalent to #buildAdornedListForm(AdornedTargetCollectionMetadata, AdornedTargetList, String) except rather than creating a new EntityForm this simply uses the EntityForm that was passed in as ef.
ListGrid	buildCollectionListGrid(String containingEntityId, DynamicResultSet drs, Property field, String sectionKey, List<SectionCrumb> sectionCrumbs)	Builds a list grid that is used to render a collection inline in an entity form.
ListGrid	buildMainListGrid(DynamicResultSet drs, ClassMetadata cmd, String sectionKey, List<SectionCrumb> sectionCrumbs)	Builds a list grid that is typically used at the top entity level to select an entity for modification.
EntityForm	buildMapForm(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId)	Builds the EntityForm used in modal dialogs when adding items to map collections.
EntityForm	buildMapForm(MapMetadata mapMd, MapStructure mapStructure, ClassMetadata cmd, String parentId, EntityForm ef)	Equivalent to FormBuilderService.buildMapForm(MapMetadata, MapStructure, ClassMetadata, String) except rather than creating a new EntityForm this simply uses the EntityForm that was passed in as ef.
protected String	buildMsgForDefValException(String type, BasicFieldMetadata fmd, String defaultValue)
Map<String,Object>	buildSelectizeCollectionInfo(String containingEntityId, DynamicResultSet drs, Property field, String sectionKey, List<SectionCrumb> sectionCrumbs)
protected String	buildSelectizeUrl(ListGrid listGrid)
protected FieldDTO	constructFieldDTOFromFieldData(Field field, BasicFieldMetadata fmd)
Map<String,Object>	constructSelectizeOptionMap(DynamicResultSet drs, ClassMetadata cmd)	constructs the selectize option map based on the dynamic result set and class metadata
protected DataWrapper	convertJsonToDataWrapper(String json)	When using Thymeleaf, we need to convert the JSON string back to a DataWrapper object because Thymeleaf escapes JSON strings.
EntityForm	createEntityForm(ClassMetadata cmd, List<SectionCrumb> sectionCrumbs)	Creates a new EntityForm with the a default 'Save' action.
EntityForm	createEntityForm(ClassMetadata cmd, Entity entity, List<SectionCrumb> sectionCrumbs)	Creates a new EntityForm that has all of the appropriate fields set up along with the values for those fields from the given Entity.
EntityForm	createEntityForm(ClassMetadata cmd, Entity entity, Map<String,DynamicResultSet> collectionRecords, List<SectionCrumb> sectionCrumbs)	Builds an EntityForm that has all of the appropriate fields set up along with the values for those fields from the given Entity as well as all sub-collections of the given Entity that appear in the collectionRecords map.
protected Field	createHeaderField(Property p, BasicFieldMetadata fmd)
protected ListGrid	createListGrid(String className, List<Field> headerFields, ListGrid.Type type, DynamicResultSet drs, String sectionKey, int order, String idProperty, List<SectionCrumb> sectionCrumbs)	Deprecated. use createListGrid(String, List, ListGrid.Type, DynamicResultSet, String, Integer, String, List, String)
protected ListGrid	createListGrid(String className, List<Field> headerFields, ListGrid.Type type, DynamicResultSet drs, String sectionKey, Integer order, String idProperty, List<SectionCrumb> sectionCrumbs, String sortPropery)	Populate a ListGrid with ListGridRecords.
protected EntityForm	createStandardAdornedEntityForm()
protected EntityForm	createStandardEntityForm()
protected String	decodeValueIfNeeded(BasicFieldMetadata basicFM, String value)
String	extractDefaultValueFromFieldData(String fieldType, BasicFieldMetadata fmd)	Extracts the DefaultValue from the FieldMetaData and parses it based on the SupportedFieldType that the field uses.
protected String	extractSectionIdentifierFromCrumb(List<SectionCrumb> sectionCrumbs)
protected void	filterMapFormProperties(List<Property> mapFormProperties, List<String> classNames)
protected boolean	foundMatchingTab(String unprocessedTabName)
protected String	getAdminSectionPath(String foreignKeyClass)	This method gets the AdminSection for the given foreignKeyClass parameter.
protected String	getFieldComponentRenderer(BasicFieldMetadata fmd)
protected VisibilityEnum[]	getFormHiddenVisibilities()
protected String	getGridFieldComponentRenderer(BasicFieldMetadata fmd)
protected VisibilityEnum[]	getGridHiddenVisibilities()
protected String	getMapKeyFriendlyName(Property property)
protected String	getSecurityClassname(EntityForm entityForm, ClassMetadata cmd)	Obtains the class name suitable for passing along to the SecurityVerifier
protected void	getTranslationSearchField(String ceilingEntity, ArrayList<FieldDTO> defaultWrapperFields)
protected String	getUnprocessedNameOfMatchingTab(TabMetadata tabMetadata, Set<String> tabMetadataKeySet)	Search for any other tab on the target entity that has the same display value as the value provided tab name.
protected List<String>	getValueClassNames(String valueClassName)
protected Field	initHeaderField(BasicFieldMetadata fmd)
protected boolean	isComboField(BasicFieldMetadata fmd)
protected boolean	isDeletionAllowed(EntityForm entityForm, ClassMetadata cmd, Entity entity)
protected Boolean	isDerivedField(Field headerField, Field recordField, Property p)	Determines whether or not a particular field in a record is derived.
protected boolean	isDuplicationAllowed(EntityForm entityForm, ClassMetadata cmd)
protected boolean	isSupportedFieldTypes(BasicFieldMetadata fmd, SupportedFieldType... supportedFieldType)
void	populateAdornedEntityFormFields(EntityForm ef, Entity entity, AdornedTargetList adornedList)	Sets values for the necessary adorned fields on the EntityForm from the specified entity.
protected void	populateDropdownToOneFields(EntityForm ef, ClassMetadata cmd)
void	populateEntityForm(ClassMetadata cmd, Entity entity, Map<String,DynamicResultSet> collectionRecords, EntityForm ef, List<SectionCrumb> sectionCrumbs)	Builds an EntityForm that has all of the appropriate fields set up along with the values for thsoe fields from the given Entity as well as all sub-collections of the given Entity that appear in the collectionRecords map.
void	populateEntityForm(ClassMetadata cmd, Entity entity, EntityForm ef, List<SectionCrumb> sectionCrumbs)	Populates a given ef based on the given cmd to initially create fields with the necessary metadata and then fills those fields out based on the property values from entity.
void	populateEntityForm(ClassMetadata cmd, EntityForm ef, List<SectionCrumb> sectionCrumbs)	Populates the given ef with all of the fields based on the properties from cmd.
void	populateEntityFormFields(EntityForm ef, Entity entity)	Delegates to FormBuilderService.populateEntityFormFields(EntityForm, Entity, boolean, boolean) with true for populating both the id and type.
void	populateEntityFormFields(EntityForm ef, Entity entity, boolean populateType, boolean populateId)	Sets values for all fields found on the EntityForm from the specified entity.
void	populateEntityFormFieldValues(ClassMetadata cmd, Entity entity, EntityForm ef)	Populates the given EntityForm with values based on the Entity that has been passed in.
void	populateMapEntityFormFields(EntityForm ef, Entity entity)	Sets values for the necessary map fields on the EntityForm from the specified entity.
protected boolean	processedTabKeyMatchesTabName(String tabName, String candidateTabKey)
protected boolean	propertyExistsInResultSet(Property property, DynamicResultSet drs)
void	removeNonApplicableFields(ClassMetadata cmd, EntityForm entityForm, String entityType)	Loops through all of the fields that are specified in given class metadata and removes fields that are not applicable for the given polymorphic entity type from the entity form.
protected void	setDateToRecordField(Field recordField, Property property, SimpleDateFormat formatter)
protected void	setEntityFormFields(ClassMetadata cmd, EntityForm ef, List<Property> properties)
protected void	setEntityFormTabsAndGroups(EntityForm ef, Map<String,TabMetadata> tabMetadataMap)	NOTE: This method will attempt to merge tabs if the unprocessed TabMetadata.getTabName() is equal to the processed value of another tab.
protected void	setReadOnlyState(EntityForm entityForm, ClassMetadata cmd, Entity entity)	The given entityForm is marked as readonly for the following cases: All of the properties from cmd are readonly The user does not have the security to EntityOperationType.UPDATE the given class name represented by the entityForm (determined by getSecurityClassname(EntityForm, ClassMetadata)) The user does not have the security necessary to modify the given entity according to the RowLevelSecurityProvider.canUpdate(AdminUser, Entity)
protected void	setVisibilityBasedOnShowIfFieldEquals(ClassMetadata cmd, Entity entity, EntityForm ef)
protected boolean	shouldHideField(FieldMetadata fmd, Entity entity)
protected boolean	tabExists(EntityForm ef, String tabKey)

Methods inherited from class java.lang.Object

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

Field Details

ALTERNATE_ID_PROPERTY

public static final String ALTERNATE_ID_PROPERTY

See Also:

• Constant Field Values

GRID_HIDDEN_VISIBILITIES

public static final VisibilityEnum[] GRID_HIDDEN_VISIBILITIES

FORM_HIDDEN_VISIBILITIES

protected static final VisibilityEnum[] FORM_HIDDEN_VISIBILITIES

adminEntityService

protected AdminEntityService adminEntityService

navigationService

protected AdminNavigationService navigationService

extensionManager

protected FormBuilderExtensionManager extensionManager

entityConfiguration

protected EntityConfiguration entityConfiguration

adminRemoteSecurityService

protected SecurityVerifier adminRemoteSecurityService

rowLevelSecurityService

protected RowLevelSecurityService rowLevelSecurityService

mediaBuilderService

protected MediaBuilderService mediaBuilderService

listGridErrorExtensionManager

protected ListGridErrorMessageExtensionManager listGridErrorExtensionManager

adminNavigationService

protected AdminNavigationService adminNavigationService

duplicator

protected EntityDuplicator duplicator

dynamicEntityDao

protected DynamicEntityDao dynamicEntityDao

localeService

protected LocaleService localeService

translationService

protected TranslationService translationService

useTranslationSearch

@Value("${use.translation.search:false}")
protected boolean useTranslationSearch

htmlEscapeMainEntityLink

@Value("${escape.html.main.link:false}")
protected boolean htmlEscapeMainEntityLink

exploitProtectionService

protected ExploitProtectionService exploitProtectionService

Constructor Details

FormBuilderServiceImpl

public FormBuilderServiceImpl()

Method Details

buildMainListGrid

public ListGrid buildMainListGrid(DynamicResultSet drs,
 ClassMetadata cmd,
 String sectionKey,
 List<SectionCrumb> sectionCrumbs)
                           throws ServiceException

Description copied from interface: FormBuilderService

Builds a list grid that is typically used at the top entity level to select an entity for modification.

Note that it can also be used in other places that require the same grid as the main entity search screen provided the type on the returned ListGrid is set appropriately.

Specified by:

buildMainListGrid in interface FormBuilderService

Returns:

the ListGrid

Throws:

ServiceException

getTranslationSearchField

protected void getTranslationSearchField(String ceilingEntity,
 ArrayList<FieldDTO> defaultWrapperFields)

constructFieldDTOFromFieldData

protected FieldDTO constructFieldDTOFromFieldData(Field field,
 BasicFieldMetadata fmd)

createHeaderField

protected Field createHeaderField(Property p,
 BasicFieldMetadata fmd)

initHeaderField

protected Field initHeaderField(BasicFieldMetadata fmd)

isComboField

protected boolean isComboField(BasicFieldMetadata fmd)

isSupportedFieldTypes

protected boolean isSupportedFieldTypes(BasicFieldMetadata fmd,
 SupportedFieldType... supportedFieldType)

buildCollectionListGrid

public ListGrid buildCollectionListGrid(String containingEntityId,
 DynamicResultSet drs,
 Property field,
 String sectionKey,
 List<SectionCrumb> sectionCrumbs)
                                 throws ServiceException

Description copied from interface: FormBuilderService

Builds a list grid that is used to render a collection inline in an entity form.

Note that it can also be used in other places that require the same grid provided the type on the returned ListGrid is set appropriately.

Specified by:

buildCollectionListGrid in interface FormBuilderService

Returns:

the ListGrid

Throws:

ServiceException

propertyExistsInResultSet

protected boolean propertyExistsInResultSet(Property property,
 DynamicResultSet drs)

getMapKeyFriendlyName

protected String getMapKeyFriendlyName(Property property)

buildSelectizeCollectionInfo

public Map<String,Object> buildSelectizeCollectionInfo(String containingEntityId,
 DynamicResultSet drs,
 Property field,
 String sectionKey,
 List<SectionCrumb> sectionCrumbs)
                                                throws ServiceException

Specified by:

buildSelectizeCollectionInfo in interface FormBuilderService

Returns:

the ListGrid

Throws:

ServiceException

constructSelectizeOptionMap

public Map<String,Object> constructSelectizeOptionMap(DynamicResultSet drs,
 ClassMetadata cmd)

Description copied from interface: FormBuilderService

constructs the selectize option map based on the dynamic result set and class metadata

Specified by:

constructSelectizeOptionMap in interface FormBuilderService

Returns:

buildSelectizeUrl

protected String buildSelectizeUrl(ListGrid listGrid)

createListGrid

@Deprecated
protected ListGrid createListGrid(String className,
 List<Field> headerFields,
 ListGrid.Type type,
 DynamicResultSet drs,
 String sectionKey,
 int order,
 String idProperty,
 List<SectionCrumb> sectionCrumbs)

Deprecated.

use createListGrid(String, List, ListGrid.Type, DynamicResultSet, String, Integer, String, List, String)

Parameters:

className -

headerFields -

type -

drs -

sectionKey -

order -

idProperty -

sectionCrumbs -

Returns:

createListGrid

protected ListGrid createListGrid(String className,
 List<Field> headerFields,
 ListGrid.Type type,
 DynamicResultSet drs,
 String sectionKey,
 Integer order,
 String idProperty,
 List<SectionCrumb> sectionCrumbs,
 String sortPropery)

Populate a ListGrid with ListGridRecords.

Parameters:

className -

headerFields -

type -

drs -

sectionKey -

order -

idProperty -

sectionCrumbs -

sortPropery -

Returns:

isDerivedField

protected Boolean isDerivedField(Field headerField,
 Field recordField,
 Property p)

Determines whether or not a particular field in a record is derived. By default this checks the BasicFieldMetadata for the given Property to see if something on the backend has marked it as derived

Parameters:

headerField - the header for this recordField

recordField - the recordField being populated

p - the property that relates to this recordField

Returns:

whether or not this field is derived

setEntityFormFields

protected void setEntityFormFields(ClassMetadata cmd,
 EntityForm ef,
 List<Property> properties)

setDateToRecordField

protected void setDateToRecordField(Field recordField,
 Property property,
 SimpleDateFormat formatter)

getFieldComponentRenderer

protected String getFieldComponentRenderer(BasicFieldMetadata fmd)

getGridFieldComponentRenderer

protected String getGridFieldComponentRenderer(BasicFieldMetadata fmd)

getAdminSectionPath

protected String getAdminSectionPath(String foreignKeyClass)

This method gets the AdminSection for the given foreignKeyClass parameter. If none exists, it returns the foreignKeyClass.

Parameters:

foreignKeyClass - the String class name

Returns:

the admin section pathname

setEntityFormTabsAndGroups

protected void setEntityFormTabsAndGroups(EntityForm ef,
 Map<String,TabMetadata> tabMetadataMap)

NOTE: This method will attempt to merge tabs if the unprocessed TabMetadata.getTabName() is equal to the processed value of another tab.

For example, if TabMetadata.getTabName() is "Example", there is a another tab where TabMetadata.getTabName() is "Example_Tab", and a message property where 'Example_Tab=Example', then the tabs should be merged together, so that we do not end up rendering multiple "Example" tabs.

getUnprocessedNameOfMatchingTab

protected String getUnprocessedNameOfMatchingTab(TabMetadata tabMetadata,
 Set<String> tabMetadataKeySet)

Search for any other tab on the target entity that has the same display value as the value provided tab name.

This assumes that the TabMetadata.getTabName() is in the form of a processed message property. For example, if TabMetadata.getTabName() is "Example", there is a tabKey from the tabMetadataKeySet that is "Example_Tab", and a message property where 'Example_Tab=Example', then this method should return "Example_Tab" which will end up causing the tabs to merge together.

If a tab with the same display value cannot be found, then we should return null to indicate that there is no matching tab with the same processed tabName value.

processedTabKeyMatchesTabName

protected boolean processedTabKeyMatchesTabName(String tabName,
 String candidateTabKey)

foundMatchingTab

protected boolean foundMatchingTab(String unprocessedTabName)

tabExists

protected boolean tabExists(EntityForm ef,
 String tabKey)

extractDefaultValueFromFieldData

public String extractDefaultValueFromFieldData(String fieldType,
 BasicFieldMetadata fmd)

Description copied from interface: FormBuilderService

Extracts the DefaultValue from the FieldMetaData and parses it based on the SupportedFieldType that the field uses.

Logs a warning in the event of failure to parse the value and returns null.

Specified by:

extractDefaultValueFromFieldData in interface FormBuilderService

Returns:

The value to be used on the form field.

buildMsgForDefValException

protected String buildMsgForDefValException(String type,
 BasicFieldMetadata fmd,
 String defaultValue)

removeNonApplicableFields

public void removeNonApplicableFields(ClassMetadata cmd,
 EntityForm entityForm,
 String entityType)

Description copied from interface: FormBuilderService

Loops through all of the fields that are specified in given class metadata and removes fields that are not applicable for the given polymorphic entity type from the entity form.

Specified by:

removeNonApplicableFields in interface FormBuilderService

createEntityForm

public EntityForm createEntityForm(ClassMetadata cmd,
 List<SectionCrumb> sectionCrumbs)
                            throws ServiceException

Description copied from interface: FormBuilderService

Creates a new EntityForm with the a default 'Save' action. This will then delegate to #populateEntityForm(ClassMetadata, EntityForm) to ensure that the newly created EntityForm has all of the appropriate fields set up without any values based on cmd

Specified by:

createEntityForm in interface FormBuilderService

Returns:

the EntityForm

Throws:

ServiceException

extractSectionIdentifierFromCrumb

protected String extractSectionIdentifierFromCrumb(List<SectionCrumb> sectionCrumbs)

populateEntityForm

public void populateEntityForm(ClassMetadata cmd,
 EntityForm ef,
 List<SectionCrumb> sectionCrumbs)
                        throws ServiceException

Description copied from interface: FormBuilderService

Populates the given ef with all of the fields based on the properties from cmd. For all the fields that are created, no values are set (as cmd usually does not have any). In order to fill out values in the given ef, consider instead calling #populateEntityForm(ClassMetadata, Entity, EntityForm, boolean)

Specified by:

populateEntityForm in interface FormBuilderService

Throws:

ServiceException

addAdditionalFormActions

protected void addAdditionalFormActions(EntityForm ef)

This method is invoked when EntityForms are created and is meant to provide a hook to add additional entity form actions for implementors of Broadleaf. Broadleaf modules will typically leverage FormBuilderExtensionHandler.addAdditionalFormActions(EntityForm) method.

Parameters:

ef -

createEntityForm

public EntityForm createEntityForm(ClassMetadata cmd,
 Entity entity,
 List<SectionCrumb> sectionCrumbs)
                            throws ServiceException

Description copied from interface: FormBuilderService

Creates a new EntityForm that has all of the appropriate fields set up along with the values for those fields from the given Entity. Delegates to #createEntityForm(ClassMetadata) for further population

Specified by:

createEntityForm in interface FormBuilderService

Parameters:

cmd - metadata that the created EntityForm should use to initialize its fields

Returns:

the EntityForm

Throws:

ServiceException

populateEntityForm

public void populateEntityForm(ClassMetadata cmd,
 Entity entity,
 EntityForm ef,
 List<SectionCrumb> sectionCrumbs)
                        throws ServiceException

Description copied from interface: FormBuilderService

Populates a given ef based on the given cmd to initially create fields with the necessary metadata and then fills those fields out based on the property values from entity.

Specified by:

populateEntityForm in interface FormBuilderService

Throws:

ServiceException

setVisibilityBasedOnShowIfFieldEquals

protected void setVisibilityBasedOnShowIfFieldEquals(ClassMetadata cmd,
 Entity entity,
 EntityForm ef)

shouldHideField

protected boolean shouldHideField(FieldMetadata fmd,
 Entity entity)

populateEntityFormFieldValues

public void populateEntityFormFieldValues(ClassMetadata cmd,
 Entity entity,
 EntityForm ef)

Description copied from interface: FormBuilderService

Populates the given EntityForm with values based on the Entity that has been passed in. The ClassMetadata is used to determine which properties should be attempted to be populated

Specified by:

populateEntityFormFieldValues in interface FormBuilderService

Parameters:

cmd - 'inspect' metadata for the class being populated

entity - the Entity that should be used to fill out the field values in the given EntityForm

ef - the EntityForm to populate field values from the given Entity

decodeValueIfNeeded

protected String decodeValueIfNeeded(BasicFieldMetadata basicFM,
 String value)

convertJsonToDataWrapper

protected DataWrapper convertJsonToDataWrapper(String json)

When using Thymeleaf, we need to convert the JSON string back to a DataWrapper object because Thymeleaf escapes JSON strings. Thymeleaf uses it's own object de-serializer see: https://github.com/thymeleaf/thymeleaf/issues/84 see: http://forum.thymeleaf.org/Spring-Javascript-and-escaped-JSON-td4024739.html

Parameters:

json -

Returns:

DataWrapper

Throws:

IOException

populateDropdownToOneFields

protected void populateDropdownToOneFields(EntityForm ef,
 ClassMetadata cmd)
                                    throws ServiceException

Throws:

ServiceException

createEntityForm

public EntityForm createEntityForm(ClassMetadata cmd,
 Entity entity,
 Map<String,DynamicResultSet> collectionRecords,
 List<SectionCrumb> sectionCrumbs)
                            throws ServiceException

Description copied from interface: FormBuilderService

Builds an EntityForm that has all of the appropriate fields set up along with the values for those fields from the given Entity as well as all sub-collections of the given Entity that appear in the collectionRecords map. This method simply delegates to create a standard EntityForm (that has a save action) and then populates that EntityForm using #populateEntityForm(ClassMetadata, Entity, Map, EntityForm).

NOTE: if you are submitting a validation result, you must not call this method and instead invoke the one that has an EntityForm as a parameter. You cannot re-assign the entityForm to the model after it has already been bound to a BindingResult, else the binding result will be removed.

Specified by:

createEntityForm in interface FormBuilderService

Returns:

the EntityForm

Throws:

ServiceException

populateEntityForm

public void populateEntityForm(ClassMetadata cmd,
 Entity entity,
 Map<String,DynamicResultSet> collectionRecords,
 EntityForm ef,
 List<SectionCrumb> sectionCrumbs)
                        throws ServiceException

Description copied from interface: FormBuilderService

Builds an EntityForm that has all of the appropriate fields set up along with the values for thsoe fields from the given Entity as well as all sub-collections of the given Entity that appear in the collectionRecords map.

NOTE: This method is mainly used when coming back from validation. In the case of validation, you cannot re-add a new EntityForm to the model or else you lose the whole BindingResult and errors will not properly be displayed. In that scenario, you must use this method rather than the one that does not take in an entityForm as it will attempt to instantiate a new object.

Specified by:

populateEntityForm in interface FormBuilderService

ef - rather than instantiate a new EntityForm, this will use this parameter to fill out

Throws:

ServiceException

addDeleteActionIfAllowed

protected void addDeleteActionIfAllowed(EntityForm entityForm,
 ClassMetadata cmd,
 Entity entity)

Adds the DefaultEntityFormActions.DELETE if the user is allowed to delete the entity. The user can delete an entity for the following cases:

1. The user has the security to EntityOperationType.REMOVE the given class name represented by the entityForm (determined by getSecurityClassname(EntityForm, ClassMetadata))
2. The user has the security necessary to delete the given entity according to the RowLevelSecurityProvider.canRemove(AdminUser, Entity)

Parameters:

entityForm - the form being generated

cmd - the metatadata used to build the entityForm for the entity

entity - the entity being edited

isDeletionAllowed

protected boolean isDeletionAllowed(EntityForm entityForm,
 ClassMetadata cmd,
 Entity entity)

addDuplicateActionIfAllowed

protected void addDuplicateActionIfAllowed(EntityForm entityForm,
 ClassMetadata cmd)

isDuplicationAllowed

protected boolean isDuplicationAllowed(EntityForm entityForm,
 ClassMetadata cmd)

setReadOnlyState

protected void setReadOnlyState(EntityForm entityForm,
 ClassMetadata cmd,
 Entity entity)

The given entityForm is marked as readonly for the following cases:

1. All of the properties from cmd are readonly
2. The user does not have the security to EntityOperationType.UPDATE the given class name represented by the entityForm (determined by getSecurityClassname(EntityForm, ClassMetadata))
3. The user does not have the security necessary to modify the given entity according to the RowLevelSecurityProvider.canUpdate(AdminUser, Entity)

Parameters:

entityForm - the form being generated

cmd - the metatadata used to build the entityForm for the entity

entity - the entity being edited

getSecurityClassname

protected String getSecurityClassname(EntityForm entityForm,
 ClassMetadata cmd)

Obtains the class name suitable for passing along to the SecurityVerifier

Parameters:

entityForm -

cmd -

Returns:

populateEntityFormFields

public void populateEntityFormFields(EntityForm ef,
 Entity entity)

Description copied from interface: FormBuilderService

Delegates to FormBuilderService.populateEntityFormFields(EntityForm, Entity, boolean, boolean) with true for populating both the id and type.

Specified by:

populateEntityFormFields in interface FormBuilderService

populateEntityFormFields

public void populateEntityFormFields(EntityForm ef,
 Entity entity,
 boolean populateType,
 boolean populateId)

Description copied from interface: FormBuilderService

Sets values for all fields found on the EntityForm from the specified entity.

Specified by:

populateEntityFormFields in interface FormBuilderService

populateType - whether or not to use the type from the given Entity or keep the current value on the EntityForm

populateId - whether or not to use the id from the given Entity or keep the current value on the EntityForm

populateAdornedEntityFormFields

public void populateAdornedEntityFormFields(EntityForm ef,
 Entity entity,
 AdornedTargetList adornedList)

Description copied from interface: FormBuilderService

Sets values for the necessary adorned fields on the EntityForm from the specified entity.

Specified by:

populateAdornedEntityFormFields in interface FormBuilderService

populateMapEntityFormFields

public void populateMapEntityFormFields(EntityForm ef,
 Entity entity)

Description copied from interface: FormBuilderService

Sets values for the necessary map fields on the EntityForm from the specified entity.

Specified by:

populateMapEntityFormFields in interface FormBuilderService

buildAdornedListForm

public EntityForm buildAdornedListForm(AdornedTargetCollectionMetadata adornedMd,
 AdornedTargetList adornedList,
 String parentId,
 boolean isViewCollectionItem,
 List<SectionCrumb> sectionCrumbs,
 boolean isAdd)
                                throws ServiceException

Description copied from interface: FormBuilderService

Builds the EntityForm used in modal dialogs when adding items to adorned target collections.

Specified by:

buildAdornedListForm in interface FormBuilderService

Returns:

the EntityForm

Throws:

ServiceException

buildAdornedListForm

public EntityForm buildAdornedListForm(AdornedTargetCollectionMetadata adornedMd,
 AdornedTargetList adornedList,
 String parentId,
 boolean isViewCollectionItem,
 EntityForm ef,
 List<SectionCrumb> sectionCrumbs,
 boolean isAdd)
                                throws ServiceException

Description copied from interface: FormBuilderService

Equivalent to #buildAdornedListForm(AdornedTargetCollectionMetadata, AdornedTargetList, String) except rather than creating a new EntityForm this simply uses the EntityForm that was passed in as ef. Used mainly when rebuilding an EntityForm after it has already been bound by Spring.

Before invoking this method, you should invoke EntityForm.clearFieldsMap() to ensure that you have a clean set of field groups and tabs for this method to work with

Specified by:

buildAdornedListForm in interface FormBuilderService

ef - the form DTO to populate

Returns:

the original EntityForm passed in but fully populated

Throws:

ServiceException

buildMapForm

public EntityForm buildMapForm(MapMetadata mapMd,
 MapStructure mapStructure,
 ClassMetadata cmd,
 String parentId)
                        throws ServiceException

Description copied from interface: FormBuilderService

Builds the EntityForm used in modal dialogs when adding items to map collections.

Specified by:

buildMapForm in interface FormBuilderService

Returns:

the EntityForm

Throws:

ServiceException

buildMapForm

public EntityForm buildMapForm(MapMetadata mapMd,
 MapStructure mapStructure,
 ClassMetadata cmd,
 String parentId,
 EntityForm ef)
                        throws ServiceException

Description copied from interface: FormBuilderService

Equivalent to FormBuilderService.buildMapForm(MapMetadata, MapStructure, ClassMetadata, String) except rather than creating a new EntityForm this simply uses the EntityForm that was passed in as ef. Used mainly when rebuilding an EntityForm after it has already been bound by Spring.

Before invoking this method, you should invoke EntityForm.clearFieldsMap() to ensure that you have a clean set of field groups and tabs for this method to work with

Specified by:

buildMapForm in interface FormBuilderService

ef - the form DTO to populate

Returns:

the original EntityForm passed in but fully populated

Throws:

ServiceException

getValueClassNames

protected List<String> getValueClassNames(String valueClassName)

filterMapFormProperties

protected void filterMapFormProperties(List<Property> mapFormProperties,
 List<String> classNames)

createStandardEntityForm

protected EntityForm createStandardEntityForm()

createStandardAdornedEntityForm

protected EntityForm createStandardAdornedEntityForm()

getGridHiddenVisibilities

protected VisibilityEnum[] getGridHiddenVisibilities()

getFormHiddenVisibilities

protected VisibilityEnum[] getFormHiddenVisibilities()