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

Class BasicEntityMetadataProvider

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

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

All Implemented Interfaces:

EntityMetadataProvider, org.springframework.core.Ordered

@Component("blBasicEntityMetadataProvider")
@Scope("prototype")
public class BasicEntityMetadataProvider
extends EntityMetadataProviderAdapter

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	Description
BasicEntityMetadataProvider()

Method Summary

Modifier and Type	Method	Description
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)
protected void	applyGroupMetadataOverrideViaAnnotation(GroupMetadata group, AdminGroupPresentationOverride groupOverride)
protected void	applyGroupMetadataOverrideViaXml(String overrideKey, GroupMetadataOverride override, Map<String,TabMetadata> metadata)
protected void	applyTabMetadataOverrideViaAnnotation(TabMetadata tab, AdminTabPresentationOverride tabOverride)
protected void	applyTabMetadataOverrideViaXml(String tabName, MetadataOverride override, Map<String,TabMetadata> metadata)
protected void	buildGroupFromMetadataOverride(String groupName, String tabName, GroupMetadataOverride override, Map<String,TabMetadata> metadata)
protected GroupMetadata	buildGroupMetadata(AdminGroupPresentation groupPresentation, Class<?> owningClass, Map<String,TabMetadata> metadata)
protected void	buildTabFromMetadataOverride(String tabName, MetadataOverride override, Map<String,TabMetadata> metadata)
protected TabMetadata	buildTabMetadata(AdminTabPresentation tabPresentation, Class<?> owningClass, Map<String,TabMetadata> metadata)
protected GroupMetadata	getGroupFromMetadata(String groupName, Map<String,TabMetadata> metadata)
int	getOrder()
protected TabMetadata	getTabFromMetadata(String tabName, Map<String,TabMetadata> metadata)
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.EntityMetadataProviderAdapter

addEntityMetadataFromMappingData, lateStageAddEntityMetadata

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 Details

BasicEntityMetadataProvider

public BasicEntityMetadataProvider()

Method Details

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.

Specified by:

addTabAndGroupMetadata in interface EntityMetadataProvider

Overrides:

addTabAndGroupMetadata in class EntityMetadataProviderAdapter

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.

Specified by:

overrideMetadataViaAnnotation in interface EntityMetadataProvider

Overrides:

overrideMetadataViaAnnotation in class EntityMetadataProviderAdapter

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.

Specified by:

overrideMetadataViaXml in interface EntityMetadataProvider

Overrides:

overrideMetadataViaXml in class EntityMetadataProviderAdapter

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)

Specified by:

addTabAndGroupMetadataFromCmdProperties in interface EntityMetadataProvider

Overrides:

addTabAndGroupMetadataFromCmdProperties in class EntityMetadataProviderAdapter

Returns:

whether or not this implementation adjusted metadata

applyTabMetadataOverrideViaAnnotation

protected void applyTabMetadataOverrideViaAnnotation(TabMetadata tab,
 AdminTabPresentationOverride tabOverride)

applyGroupMetadataOverrideViaAnnotation

protected void applyGroupMetadataOverrideViaAnnotation(GroupMetadata group,
 AdminGroupPresentationOverride groupOverride)

applyGroupMetadataOverrideViaXml

protected void applyGroupMetadataOverrideViaXml(String overrideKey,
 GroupMetadataOverride override,
 Map<String,TabMetadata> metadata)

buildGroupFromMetadataOverride

protected void buildGroupFromMetadataOverride(String groupName,
 String tabName,
 GroupMetadataOverride override,
 Map<String,TabMetadata> metadata)

applyTabMetadataOverrideViaXml

protected void applyTabMetadataOverrideViaXml(String tabName,
 MetadataOverride override,
 Map<String,TabMetadata> metadata)

buildTabFromMetadataOverride

protected void buildTabFromMetadataOverride(String tabName,
 MetadataOverride override,
 Map<String,TabMetadata> metadata)

buildTabMetadata

protected TabMetadata buildTabMetadata(AdminTabPresentation tabPresentation,
 Class<?> owningClass,
 Map<String,TabMetadata> metadata)

buildGroupMetadata

protected GroupMetadata buildGroupMetadata(AdminGroupPresentation groupPresentation,
 Class<?> owningClass,
 Map<String,TabMetadata> metadata)

getTabFromMetadata

protected TabMetadata getTabFromMetadata(String tabName,
 Map<String,TabMetadata> metadata)

getGroupFromMetadata

protected GroupMetadata getGroupFromMetadata(String groupName,
 Map<String,TabMetadata> metadata)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class EntityMetadataProviderAdapter