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

Class FieldMetadataProviderAdapter

java.lang.Object
org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractMetadataProvider
org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractFieldMetadataProvider
org.broadleafcommerce.openadmin.server.dao.provider.metadata.FieldMetadataProviderAdapter
All Implemented Interfaces:
FieldMetadataProvider, org.springframework.core.Ordered
Direct Known Subclasses:
AdvancedCollectionFieldMetadataProvider, BasicFieldMetadataProvider
public class FieldMetadataProviderAdapter extends AbstractFieldMetadataProvider
Author:
Jeff Fischer

  • Constructor Details

    • FieldMetadataProviderAdapter

      public FieldMetadataProviderAdapter()

  • Method Details

    • addMetadata

      public MetadataProviderResponse addMetadata(AddFieldMetadataRequest addFieldMetadataRequest, 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.
      Parameters:
      addFieldMetadataRequest - 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

      public MetadataProviderResponse lateStageAddMetadata(LateStageAddMetadataRequest 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.

      This method differs from FieldMetadataProvider.addMetadata(AddFieldMetadataRequest, 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

    • overrideViaAnnotation

      public MetadataProviderResponse 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.
      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 MetadataProviderResponse 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.
      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

      public MetadataProviderResponse 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.
      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 MetadataProviderResponse 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.
      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

    • getOrder

      public int getOrder()