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

Interface FieldMetadataProvider

All Superinterfaces:

org.springframework.core.Ordered

All Known Implementing Classes:

AbstractFieldMetadataProvider, AdornedTargetCollectionFieldMetadataProvider, AdvancedCollectionFieldMetadataProvider, BasicFieldMetadataProvider, CollectionFieldMetadataProvider, DefaultFieldMetadataProvider, FieldMetadataProviderAdapter, MapFieldMetadataProvider, MapFieldsFieldMetadataProvider, PasswordFieldMetadataProvider

public interface FieldMetadataProvider
extends org.springframework.core.Ordered

Classes implementing this interface are capable of manipulating metadata for a field resulting from the inspection phase for the admin. Providers are typically added in response to new admin presentation annotation support. Implementers should generally extend FieldMetadataProviderAdapter.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADORNED_TARGET
static int	BASIC
static int	COLLECTION
static int	MAP
static int	MAP_FIELD

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

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.
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.
FieldProviderResponse	lateStageAddMetadata(LateStageAddMetadataRequest addMetadataRequest, Map<String,FieldMetadata> metadata) Contribute to metadata inspection for the Field instance in the request.
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 interface org.springframework.core.Ordered

getOrder

Field Detail

BASIC

static final int BASIC

See Also:

Constant Field Values

COLLECTION

static final int COLLECTION

See Also:

Constant Field Values

ADORNED_TARGET

static final int ADORNED_TARGET

See Also:

Constant Field Values

MAP

static final int MAP

See Also:

Constant Field Values

MAP_FIELD

static final int MAP_FIELD

See Also:

Constant Field Values

Method Detail

addMetadata

FieldProviderResponse addMetadata(AddMetadataRequest addMetadataRequest,
                                Map<String,FieldMetadata> metadata)

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

lateStageAddMetadata

FieldProviderResponse lateStageAddMetadata(LateStageAddMetadataRequest addMetadataRequest,
                                         Map<String,FieldMetadata> metadata)

Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter. This method differs from addMetadata(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:

lateStageAddMetadataRequest - 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

overrideViaAnnotation

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

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

overrideViaXml

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

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

addMetadataFromMappingData

FieldProviderResponse addMetadataFromMappingData(AddMetadataFromMappingDataRequest addMetadataFromMappingDataRequest,
                                               FieldMetadata metadata)

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

addMetadataFromFieldType

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

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.

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