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

Class EntityMetadataProviderAdapter

java.lang.Object

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

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

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

All Implemented Interfaces:

EntityMetadataProvider, org.springframework.core.Ordered

Direct Known Subclasses:

BasicEntityMetadataProvider

public class EntityMetadataProviderAdapter
extends AbstractEntityMetadataProvider

Author:

Chris Kittrell

Field Summary

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

metadataOverrides

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
EntityMetadataProviderAdapter()

Method Summary

Modifier and Type	Method and Description
MetadataProviderResponse	addEntityMetadataFromMappingData(AddMetadataFromMappingDataRequest addMetadataFromMappingDataRequest, TabMetadata metadata) Contribute to metadata inspection using Hibernate column information.
MetadataProviderResponse	addTabAndGroupMetadata(AddMetadataRequest addMetadataRequest, Map<String,TabMetadata> metadata) Contribute to metadata inspection for the Field instance in the request.
MetadataProviderResponse	addTabAndGroupMetadataFromCmdProperties(ClassMetadata cmd, Map<String,TabMetadata> metadata)
int	getOrder()
MetadataProviderResponse	lateStageAddEntityMetadata(LateStageAddMetadataRequest addMetadataRequest, Map<String,TabMetadata> metadata) Contribute to metadata inspection for the Field instance in the request.
MetadataProviderResponse	overrideMetadataViaAnnotation(OverrideViaAnnotationRequest overrideViaAnnotationRequest, Map<String,TabMetadata> metadata) Contribute to metadata inspection for the entity in the request.
MetadataProviderResponse	overrideMetadataViaXml(OverrideViaXmlRequest overrideViaXmlRequest, Map<String,TabMetadata> metadata) Contribute to metadata inspection for the ceiling entity and config key.

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

getTargetedOverride, setMetadataOverrides

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityMetadataProviderAdapter

public EntityMetadataProviderAdapter()

Method Detail

addTabAndGroupMetadata

public MetadataProviderResponse addTabAndGroupMetadata(AddMetadataRequest addMetadataRequest,
                                                       Map<String,TabMetadata> metadata)

Description copied from interface: EntityMetadataProvider

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

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

overrideMetadataViaAnnotation

public MetadataProviderResponse overrideMetadataViaAnnotation(OverrideViaAnnotationRequest overrideViaAnnotationRequest,
                                                              Map<String,TabMetadata> metadata)

Description copied from interface: EntityMetadataProvider

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

Parameters:

overrideViaAnnotationRequest - contains the requested entity and support classes.

metadata - implementations should override metadata here

Returns:

whether or not this implementation adjusted metadata

overrideMetadataViaXml

public MetadataProviderResponse overrideMetadataViaXml(OverrideViaXmlRequest overrideViaXmlRequest,
                                                       Map<String,TabMetadata> metadata)

Description copied from interface: EntityMetadataProvider

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

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

addTabAndGroupMetadataFromCmdProperties

public MetadataProviderResponse addTabAndGroupMetadataFromCmdProperties(ClassMetadata cmd,
                                                                        Map<String,TabMetadata> metadata)

Returns:

whether or not this implementation adjusted metadata

lateStageAddEntityMetadata

public MetadataProviderResponse lateStageAddEntityMetadata(LateStageAddMetadataRequest addMetadataRequest,
                                                           Map<String,TabMetadata> metadata)

Description copied from interface: EntityMetadataProvider

Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter. This method differs from EntityMetadataProvider.addTabAndGroupMetadata(AddMetadataRequest, Map) in that it will be invoked after the cacheable properties are assembled. It is therefore useful in scenarios where you may want to contribute properties to metadata that are dynamic and should not be cached normally.

Parameters:

addMetadataRequest - contains the requested field name and support classes.

metadata - implementations should add metadata for the requested field here

Returns:

whether or not this implementation adjusted metadata

addEntityMetadataFromMappingData

public MetadataProviderResponse addEntityMetadataFromMappingData(AddMetadataFromMappingDataRequest addMetadataFromMappingDataRequest,
                                                                 TabMetadata metadata)

Description copied from interface: EntityMetadataProvider

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

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

getOrder

public int getOrder()