Package org.broadleafcommerce.openadmin.server.service.persistence.module.provider

Class MapFieldPersistenceProvider

java.lang.Object

org.broadleafcommerce.openadmin.server.service.persistence.module.provider.AbstractFieldPersistenceProvider

org.broadleafcommerce.openadmin.server.service.persistence.module.provider.FieldPersistenceProviderAdapter

org.broadleafcommerce.openadmin.server.service.persistence.module.provider.BasicFieldPersistenceProvider

org.broadleafcommerce.openadmin.server.service.persistence.module.provider.MapFieldPersistenceProvider

All Implemented Interfaces:

FieldPersistenceProvider, org.springframework.core.Ordered

@Component("blMapFieldPersistenceProvider")
@Scope("prototype")
public class MapFieldPersistenceProvider
extends BasicFieldPersistenceProvider

Author:

Jeff Fischer

Field Summary

Fields inherited from class org.broadleafcommerce.openadmin.server.service.persistence.module.provider.BasicFieldPersistenceProvider

extensionManager, LOG

Fields inherited from interface org.broadleafcommerce.openadmin.server.service.persistence.module.provider.FieldPersistenceProvider

BASIC, HTML, MAP_FIELD, MEDIA, MONEY, RULE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MapFieldPersistenceProvider()

Method Summary

Modifier and Type	Method	Description
MetadataProviderResponse	addSearchMapping(AddSearchMappingRequest addSearchMappingRequest, List<FilterMapping> filterMappings)	Add FilterMapping instances.
protected boolean	canHandleExtraction(ExtractValueRequest extractValueRequest, Property property)
protected boolean	canHandlePersistence(PopulateValueRequest populateValueRequest, Serializable instance)
boolean	canHandlePopulateNull()	If the provider should handle populating null values or if it should delegate to the default persistence provider
protected org.broadleafcommerce.common.value.ValueAssignable	establishAssignableValue(PopulateValueRequest populateValueRequest, Object parent)
MetadataProviderResponse	extractValue(ExtractValueRequest extractValueRequest, Property property)	Retrieve the property value from the requestedValue field from the request.
int	getOrder()
protected Class<?>	getStartingValueType(PopulateValueRequest populateValueRequest)
protected Class<?>	getValueType(PopulateValueRequest populateValueRequest, Class<?> startingValueType)
MetadataProviderResponse	populateValue(PopulateValueRequest populateValueRequest, Serializable instance)	Set the property value on the target object.
protected void	setupJoinEntityParent(PopulateValueRequest populateValueRequest, Serializable instance, Object parent)
protected void	updateAssignableValue(PopulateValueRequest populateValueRequest, Serializable instance, Object parent, Class<?> valueType, boolean persistValue, org.broadleafcommerce.common.value.ValueAssignable assignableValue)

Methods inherited from class org.broadleafcommerce.openadmin.server.service.persistence.module.provider.BasicFieldPersistenceProvider

canHandleSearchMapping, detectAdditionalSearchTypes, detectBasicType, getDateFormatToExtractValue, getDateFormatToPopulateValue

Methods inherited from class org.broadleafcommerce.openadmin.server.service.persistence.module.provider.FieldPersistenceProviderAdapter

checkDirtyState, filterProperties, isFieldDirty, setNonDisplayableValues

Methods inherited from class org.broadleafcommerce.openadmin.server.service.persistence.module.provider.AbstractFieldPersistenceProvider

alwaysRun, buildFieldInfo, getListFieldType, getMapFieldType

Methods inherited from class java.lang.Object

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

Constructor Details

MapFieldPersistenceProvider

public MapFieldPersistenceProvider()

Method Details

canHandlePersistence

protected boolean canHandlePersistence(PopulateValueRequest populateValueRequest,
 Serializable instance)

Overrides:

canHandlePersistence in class BasicFieldPersistenceProvider

canHandleExtraction

protected boolean canHandleExtraction(ExtractValueRequest extractValueRequest,
 Property property)

Overrides:

canHandleExtraction in class BasicFieldPersistenceProvider

populateValue

public MetadataProviderResponse populateValue(PopulateValueRequest populateValueRequest,
 Serializable instance)

Description copied from interface: FieldPersistenceProvider

Set the property value on the target object. Implementations should translate the requestedValue field from the request and set on the instance parameter. You are basically taking the string value submitted by the admin application and converting it into the format required to set on the target field of instance (which should be a JPA managed entity). Used during admin create and update events.

Specified by:

populateValue in interface FieldPersistenceProvider

Overrides:

populateValue in class BasicFieldPersistenceProvider

Parameters:

populateValueRequest - contains the requested value and support classes.

instance - the persistence entity instance on which to set the value harvested from the request

Returns:

whether or not the implementation handled the persistence request

extractValue

public MetadataProviderResponse extractValue(ExtractValueRequest extractValueRequest,
 Property property)
                                      throws PersistenceException

Description copied from interface: FieldPersistenceProvider

Retrieve the property value from the requestedValue field from the request. Implementations should translate the requestedValue and set on the property parameter. The requestedValue is the field value taken from the JPA managed entity instance. You are taking this field value and converting it into a string representation appropriate for the property instance parameter. Used during admin fetch events.

Specified by:

extractValue in interface FieldPersistenceProvider

Overrides:

extractValue in class BasicFieldPersistenceProvider

Parameters:

extractValueRequest - contains the requested value and support classes.

property - the property for the admin that will contain the information harvested from the persistence value

Returns:

whether or not the implementation handled the persistence request

Throws:

PersistenceException

addSearchMapping

public MetadataProviderResponse addSearchMapping(AddSearchMappingRequest addSearchMappingRequest,
 List<FilterMapping> filterMappings)

Description copied from interface: FieldPersistenceProvider

Add FilterMapping instances. The FilterMappings are used by the system to refine the fetch criteria used to retrieve lists of records for the admin. The requestedCto contains filters requested from the admin and is generally used to drive the added FilterMapping instances.

Specified by:

addSearchMapping in interface FieldPersistenceProvider

Overrides:

addSearchMapping in class BasicFieldPersistenceProvider

Parameters:

addSearchMappingRequest - contains the requested cto and support classes.

filterMappings - filter criteria should be added here. It is used to generate the final search criteria.

Returns:

whether or not the implementation handled the persistence request

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class BasicFieldPersistenceProvider

canHandlePopulateNull

public boolean canHandlePopulateNull()

Description copied from interface: FieldPersistenceProvider

If the provider should handle populating null values or if it should delegate to the default persistence provider

Specified by:

canHandlePopulateNull in interface FieldPersistenceProvider

Overrides:

canHandlePopulateNull in class AbstractFieldPersistenceProvider

Returns:

updateAssignableValue

protected void updateAssignableValue(PopulateValueRequest populateValueRequest,
 Serializable instance,
 Object parent,
 Class<?> valueType,
 boolean persistValue,
 org.broadleafcommerce.common.value.ValueAssignable assignableValue)
                              throws IllegalAccessException,
FieldNotAvailableException,
InstantiationException

Throws:

IllegalAccessException

FieldNotAvailableException

InstantiationException

establishAssignableValue

protected org.broadleafcommerce.common.value.ValueAssignable establishAssignableValue(PopulateValueRequest populateValueRequest,
 Object parent)
                                                                               throws IllegalAccessException,
FieldNotAvailableException

Throws:

IllegalAccessException

FieldNotAvailableException

setupJoinEntityParent

protected void setupJoinEntityParent(PopulateValueRequest populateValueRequest,
 Serializable instance,
 Object parent)
                              throws IllegalAccessException,
FieldNotAvailableException,
InstantiationException

Throws:

IllegalAccessException

FieldNotAvailableException

InstantiationException

getValueType

protected Class<?> getValueType(PopulateValueRequest populateValueRequest,
 Class<?> startingValueType)

getStartingValueType

protected Class<?> getStartingValueType(PopulateValueRequest populateValueRequest)
                                 throws ClassNotFoundException,
IllegalAccessException

Throws:

ClassNotFoundException

IllegalAccessException