org.broadleafcommerce.openadmin.server.dao.provider.metadata

Class AdornedTargetCollectionFieldMetadataProvider

java.lang.Object

org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractFieldMetadataProvider

org.broadleafcommerce.openadmin.server.dao.provider.metadata.FieldMetadataProviderAdapter

org.broadleafcommerce.openadmin.server.dao.provider.metadata.AdvancedCollectionFieldMetadataProvider

org.broadleafcommerce.openadmin.server.dao.provider.metadata.AdornedTargetCollectionFieldMetadataProvider

All Implemented Interfaces:

FieldMetadataProvider, org.springframework.core.Ordered

@Component(value="blAdornedTargetCollectionFieldMetadataProvider")
@Scope(value="prototype")
public class AdornedTargetCollectionFieldMetadataProvider
extends AdvancedCollectionFieldMetadataProvider

Author:

Jeff Fischer

Field Summary

Fields inherited from class org.broadleafcommerce.openadmin.server.dao.provider.metadata.AdvancedCollectionFieldMetadataProvider

defaultMetadataProvider, FOREIGN_KEY_ADDITIONAL_METADATA_KEY

Fields inherited from class org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractFieldMetadataProvider

entityConfiguration, enumerationUtility, metadataOverrides

Fields inherited from interface org.broadleafcommerce.openadmin.server.dao.provider.metadata.FieldMetadataProvider

ADORNED_TARGET, BASIC, COLLECTION, MAP, MAP_FIELD

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AdornedTargetCollectionFieldMetadataProvider()

Method Summary

Methods

Modifier and Type	Method and Description
MetadataProviderResponse	addMetadata(AddFieldMetadataRequest addMetadataRequest, Map<String,FieldMetadata> metadata) Contribute to metadata inspection for the Field instance in the request.
MetadataProviderResponse	addMetadataFromFieldType(AddMetadataFromFieldTypeRequest addMetadataFromFieldTypeRequest, Map<String,FieldMetadata> metadata) Contribute to metadata inspection for the Field instance in the request.
protected void	buildAdminPresentationAdornedTargetCollectionOverride(String prefix, Boolean isParentExcluded, Map<String,FieldMetadata> mergedProperties, Map<String,AdminPresentationAdornedTargetCollectionOverride> presentationAdornedTargetCollectionOverrides, String propertyName, String key, DynamicEntityDao dynamicEntityDao)
protected void	buildAdornedTargetCollectionMetadata(Class<?> parentClass, Class<?> targetClass, Map<String,FieldMetadata> attributes, FieldInfo field, FieldMetadataOverride adornedTargetCollectionMetadata, DynamicEntityDao dynamicEntityDao)
protected boolean	canHandleAnnotationOverride(OverrideViaAnnotationRequest overrideViaAnnotationRequest, Map<String,FieldMetadata> metadata)
protected boolean	canHandleFieldForConfiguredMetadata(AddFieldMetadataRequest addMetadataRequest, Map<String,FieldMetadata> metadata)
protected boolean	canHandleFieldForTypeMetadata(AddMetadataFromFieldTypeRequest addMetadataFromFieldTypeRequest, Map<String,FieldMetadata> metadata)
protected FieldMetadataOverride	constructAdornedTargetCollectionMetadataOverride(AdminPresentationAdornedTargetCollection adornedTargetCollection)
int	getOrder()
protected FieldMetadataOverride	overrideAdornedTargetMergeMetadata(AdminPresentationMergeOverride merge)
MetadataProviderResponse	overrideViaAnnotation(OverrideViaAnnotationRequest overrideViaAnnotationRequest, Map<String,FieldMetadata> metadata) Contribute to metadata inspection for the entity in the request.
MetadataProviderResponse	overrideViaXml(OverrideViaXmlRequest overrideViaXmlRequest, Map<String,FieldMetadata> metadata) Contribute to metadata inspection for the ceiling entity and config key.

Methods inherited from class org.broadleafcommerce.openadmin.server.dao.provider.metadata.FieldMetadataProviderAdapter

addMetadataFromMappingData, lateStageAddMetadata

Methods inherited from class org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractFieldMetadataProvider

buildFieldInfo, convertType, getAdminPresentationEntries, getBasicJavaType, getTargetedOverride, getTargetedOverride, setClassOwnership, setMetadataOverrides, setupBroadleafEnumeration

Methods inherited from class java.lang.Object

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

Constructor Detail

AdornedTargetCollectionFieldMetadataProvider

public AdornedTargetCollectionFieldMetadataProvider()

Method Detail

canHandleFieldForConfiguredMetadata

protected boolean canHandleFieldForConfiguredMetadata(AddFieldMetadataRequest addMetadataRequest,
                                          Map<String,FieldMetadata> metadata)

canHandleFieldForTypeMetadata

protected boolean canHandleFieldForTypeMetadata(AddMetadataFromFieldTypeRequest addMetadataFromFieldTypeRequest,
                                    Map<String,FieldMetadata> metadata)

Overrides:

canHandleFieldForTypeMetadata in class AdvancedCollectionFieldMetadataProvider

canHandleAnnotationOverride

protected boolean canHandleAnnotationOverride(OverrideViaAnnotationRequest overrideViaAnnotationRequest,
                                  Map<String,FieldMetadata> metadata)

addMetadata

public MetadataProviderResponse addMetadata(AddFieldMetadataRequest addMetadataRequest,
                                   Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter.

Specified by:

addMetadata in interface FieldMetadataProvider

Overrides:

addMetadata in class FieldMetadataProviderAdapter

Parameters:

addMetadataRequest - contains the requested field and support classes.

metadata - implementations should add metadata for the requested field here

Returns:

whether or not this implementation adjusted metadata

overrideViaAnnotation

public MetadataProviderResponse overrideViaAnnotation(OverrideViaAnnotationRequest overrideViaAnnotationRequest,
                                             Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the entity in the request. Implementations should override values in the metadata parameter.

Specified by:

overrideViaAnnotation in interface FieldMetadataProvider

Overrides:

overrideViaAnnotation in class FieldMetadataProviderAdapter

Parameters:

overrideViaAnnotationRequest - contains the requested entity and support classes.

metadata - implementations should override metadata here

Returns:

whether or not this implementation adjusted metadata

overrideViaXml

public MetadataProviderResponse overrideViaXml(OverrideViaXmlRequest overrideViaXmlRequest,
                                      Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the ceiling entity and config key. Implementations should override values in the metadata parameter.

Specified by:

overrideViaXml in interface FieldMetadataProvider

Overrides:

overrideViaXml in class FieldMetadataProviderAdapter

Parameters:

overrideViaXmlRequest - contains the requested config key, ceiling entity and support classes.

metadata - implementations should override metadata here

Returns:

whether or not this implementation adjusted metadata

addMetadataFromFieldType

public MetadataProviderResponse addMetadataFromFieldType(AddMetadataFromFieldTypeRequest addMetadataFromFieldTypeRequest,
                                                Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter. This is metadata based on the field type.

Specified by:

addMetadataFromFieldType in interface FieldMetadataProvider

Overrides:

addMetadataFromFieldType in class AdvancedCollectionFieldMetadataProvider

Parameters:

addMetadataFromFieldTypeRequest - contains the requested field, property name and support classes.

metadata - implementations should add values for the field here

Returns:

whether or not this implementation adjusted metadata

overrideAdornedTargetMergeMetadata

protected FieldMetadataOverride overrideAdornedTargetMergeMetadata(AdminPresentationMergeOverride merge)

buildAdminPresentationAdornedTargetCollectionOverride

protected void buildAdminPresentationAdornedTargetCollectionOverride(String prefix,
                                                         Boolean isParentExcluded,
                                                         Map<String,FieldMetadata> mergedProperties,
                                                         Map<String,AdminPresentationAdornedTargetCollectionOverride> presentationAdornedTargetCollectionOverrides,
                                                         String propertyName,
                                                         String key,
                                                         DynamicEntityDao dynamicEntityDao)

constructAdornedTargetCollectionMetadataOverride

protected FieldMetadataOverride constructAdornedTargetCollectionMetadataOverride(AdminPresentationAdornedTargetCollection adornedTargetCollection)

buildAdornedTargetCollectionMetadata

protected void buildAdornedTargetCollectionMetadata(Class<?> parentClass,
                                        Class<?> targetClass,
                                        Map<String,FieldMetadata> attributes,
                                        FieldInfo field,
                                        FieldMetadataOverride adornedTargetCollectionMetadata,
                                        DynamicEntityDao dynamicEntityDao)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class FieldMetadataProviderAdapter