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

Class CollectionFieldMetadataProvider

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.CollectionFieldMetadataProvider

All Implemented Interfaces:

FieldMetadataProvider, org.springframework.core.Ordered

@Component(value="blCollectionFieldMetadataProvider")
@Scope(value="prototype")
public class CollectionFieldMetadataProvider
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
CollectionFieldMetadataProvider()

Method Summary

Methods

Modifier and Type	Method and Description
FieldProviderResponse	addMetadata(AddMetadataRequest addMetadataRequest, Map<String,FieldMetadata> metadata) Contribute to metadata inspection for the Field instance in the request.
protected void	buildAdminPresentationCollectionOverride(String prefix, Boolean isParentExcluded, Map<String,FieldMetadata> mergedProperties, Map<String,AdminPresentationCollectionOverride> presentationCollectionOverrides, String propertyName, String key, DynamicEntityDao dynamicEntityDao)
protected void	buildCollectionMetadata(Class<?> parentClass, Class<?> targetClass, Map<String,FieldMetadata> attributes, FieldInfo field, FieldMetadataOverride collectionMetadata, String prefix)
protected boolean	canHandleAnnotationOverride(OverrideViaAnnotationRequest overrideViaAnnotationRequest, Map<String,FieldMetadata> metadata)
protected boolean	canHandleFieldForConfiguredMetadata(AddMetadataRequest addMetadataRequest, Map<String,FieldMetadata> metadata)
protected FieldMetadataOverride	constructBasicCollectionMetadataOverride(AdminPresentationCollection annotColl)
int	getOrder()
protected FieldMetadataOverride	overrideCollectionMergeMetadata(AdminPresentationMergeOverride merge)
FieldProviderResponse	overrideViaAnnotation(OverrideViaAnnotationRequest overrideViaAnnotationRequest, Map<String,FieldMetadata> metadata) Contribute to metadata inspection for the entity in the request.
FieldProviderResponse	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.AdvancedCollectionFieldMetadataProvider

addMetadataFromFieldType, canHandleFieldForTypeMetadata

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

CollectionFieldMetadataProvider

public CollectionFieldMetadataProvider()

Method Detail

canHandleFieldForConfiguredMetadata

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

canHandleAnnotationOverride

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

addMetadata

public FieldProviderResponse addMetadata(AddMetadataRequest 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 FieldProviderResponse 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 FieldProviderResponse 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

buildAdminPresentationCollectionOverride

protected void buildAdminPresentationCollectionOverride(String prefix,
                                            Boolean isParentExcluded,
                                            Map<String,FieldMetadata> mergedProperties,
                                            Map<String,AdminPresentationCollectionOverride> presentationCollectionOverrides,
                                            String propertyName,
                                            String key,
                                            DynamicEntityDao dynamicEntityDao)

overrideCollectionMergeMetadata

protected FieldMetadataOverride overrideCollectionMergeMetadata(AdminPresentationMergeOverride merge)

constructBasicCollectionMetadataOverride

protected FieldMetadataOverride constructBasicCollectionMetadataOverride(AdminPresentationCollection annotColl)

buildCollectionMetadata

protected void buildCollectionMetadata(Class<?> parentClass,
                           Class<?> targetClass,
                           Map<String,FieldMetadata> attributes,
                           FieldInfo field,
                           FieldMetadataOverride collectionMetadata,
                           String prefix)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class FieldMetadataProviderAdapter