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

Class DefaultFieldMetadataProvider

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

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

All Implemented Interfaces:

FieldMetadataProvider, org.springframework.core.Ordered

Direct Known Subclasses:

MapFieldsFieldMetadataProvider

@Component(value="blDefaultFieldMetadataProvider")
 @Scope(value="prototype")
public class DefaultFieldMetadataProvider
extends BasicFieldMetadataProvider

Author:

Jeff Fischer

Field Summary

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
DefaultFieldMetadataProvider()

Method Summary

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.
FieldProviderResponse	addMetadataFromFieldType(AddMetadataFromFieldTypeRequest addMetadataFromFieldTypeRequest, Map<String,FieldMetadata> metadata) Contribute to metadata inspection for the Field instance in the request.
FieldProviderResponse	addMetadataFromMappingData(AddMetadataFromMappingDataRequest addMetadataFromMappingDataRequest, FieldMetadata metadata) Contribute to metadata inspection using Hibernate column information.
void	overrideExclusionsFromXml(OverrideViaXmlRequest overrideViaXmlRequest, Map<String,FieldMetadata> metadata)

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

buildAdminPresentationDataDrivenEnumerationOverride, buildAdminPresentationOverride, buildAdminPresentationToOneLookupOverride, buildBasicMetadata, buildDataDrivenList, canHandleAnnotationOverride, canHandleFieldForConfiguredMetadata, constructBasicMetadataOverride, getOrder, overrideMergeMetadata, overrideViaAnnotation, overrideViaXml, processValidationAnnotations

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

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

DefaultFieldMetadataProvider

public DefaultFieldMetadataProvider()

Method Detail

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 BasicFieldMetadataProvider

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

overrideExclusionsFromXml

public void overrideExclusionsFromXml(OverrideViaXmlRequest overrideViaXmlRequest,
                                      Map<String,FieldMetadata> metadata)

addMetadataFromMappingData

public FieldProviderResponse addMetadataFromMappingData(AddMetadataFromMappingDataRequest addMetadataFromMappingDataRequest,
                                                        FieldMetadata metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection using Hibernate column information. Implementations should impact values in the metadata parameter.

Specified by:

addMetadataFromMappingData in interface FieldMetadataProvider

Overrides:

addMetadataFromMappingData in class FieldMetadataProviderAdapter

Parameters:

addMetadataFromMappingDataRequest - contains the requested Hibernate type and support classes.

metadata - implementations should impact values for the metadata for the field here

Returns:

whether or not this implementation adjusted metadata

addMetadataFromFieldType

public FieldProviderResponse 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 FieldMetadataProviderAdapter

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