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

Class MediaFieldPersistenceProvider

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.MediaFieldPersistenceProvider

All Implemented Interfaces:

FieldPersistenceProvider, org.springframework.core.Ordered

@Component("blMediaFieldPersistenceProvider")
@Scope("prototype")
public class MediaFieldPersistenceProvider
extends FieldPersistenceProviderAdapter

Author:

Brian Polster

Field Summary

Fields

Modifier and Type	Field	Description
protected EntityConfiguration	entityConfiguration
protected MediaFieldPersistenceProviderExtensionManager	extensionManager
protected MediaBuilderService	mediaBuilderService
protected SandBoxHelper	sandBoxHelper

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
MediaFieldPersistenceProvider()

Method Summary

Modifier and Type	Method	Description
protected boolean	canHandleExtraction(ExtractValueRequest extractValueRequest, Property property)
protected boolean	canHandlePersistence(PopulateValueRequest populateValueRequest, Serializable instance)
protected boolean	checkEquality(Object one, Object two)
protected String	convertMediaToJson(Media media)
protected boolean	establishDirtyState(Media newMedia, Media media)
protected Object	extractParent(PopulateValueRequest populateValueRequest, Serializable instance)
MetadataProviderResponse	extractValue(ExtractValueRequest extractValueRequest, Property property)	Retrieve the property value from the requestedValue field from the request.
MetadataProviderResponse	filterProperties(AddFilterPropertiesRequest addFilterPropertiesRequest, Map<String,FieldMetadata> properties)	Filter the list of properties posted by the admin during and add or update.
int	getOrder()
protected Class<?>	getStartingValueType(PopulateValueRequest populateValueRequest)
MetadataProviderResponse	populateValue(PopulateValueRequest populateValueRequest, Serializable instance)	Set the property value on the target object.
protected void	updateMedia(PopulateValueRequest populateValueRequest, Media newMedia, boolean persist, Media media)
protected void	updateMediaFields(Media oldMedia, Media newMedia)

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

addSearchMapping, checkDirtyState, isFieldDirty, setNonDisplayableValues

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

alwaysRun, buildFieldInfo, canHandlePopulateNull, getListFieldType, getMapFieldType

Methods inherited from class java.lang.Object

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

Field Details

entityConfiguration

protected EntityConfiguration entityConfiguration

sandBoxHelper

protected SandBoxHelper sandBoxHelper

extensionManager

protected MediaFieldPersistenceProviderExtensionManager extensionManager

mediaBuilderService

protected MediaBuilderService mediaBuilderService

Constructor Details

MediaFieldPersistenceProvider

public MediaFieldPersistenceProvider()

Method Details

canHandlePersistence

protected boolean canHandlePersistence(PopulateValueRequest populateValueRequest,
 Serializable instance)

canHandleExtraction

protected boolean canHandleExtraction(ExtractValueRequest extractValueRequest,
 Property property)

populateValue

public MetadataProviderResponse populateValue(PopulateValueRequest populateValueRequest,
 Serializable instance)
                                       throws PersistenceException

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 FieldPersistenceProviderAdapter

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

Throws:

PersistenceException

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 FieldPersistenceProviderAdapter

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

filterProperties

public MetadataProviderResponse filterProperties(AddFilterPropertiesRequest addFilterPropertiesRequest,
 Map<String,FieldMetadata> properties)

Description copied from interface: FieldPersistenceProvider

Filter the list of properties posted by the admin during and add or update. This is the property list immediately before persistence is attempted. Properties may be altered, removed or added.

Specified by:

filterProperties in interface FieldPersistenceProvider

Overrides:

filterProperties in class FieldPersistenceProviderAdapter

Parameters:

addFilterPropertiesRequest - contains the Entity instance.

properties - the collection of properties to filter

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 FieldPersistenceProviderAdapter

updateMedia

protected void updateMedia(PopulateValueRequest populateValueRequest,
 Media newMedia,
 boolean persist,
 Media media)
                    throws IllegalAccessException,
FieldNotAvailableException

Throws:

IllegalAccessException

FieldNotAvailableException

checkEquality

protected boolean checkEquality(Object one,
 Object two)

establishDirtyState

protected boolean establishDirtyState(Media newMedia,
 Media media)
                               throws IllegalAccessException,
InvocationTargetException,
NoSuchMethodException

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

getStartingValueType

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

Throws:

ClassNotFoundException

IllegalAccessException

convertMediaToJson

protected String convertMediaToJson(Media media)

updateMediaFields

protected void updateMediaFields(Media oldMedia,
 Media newMedia)

extractParent

protected Object extractParent(PopulateValueRequest populateValueRequest,
 Serializable instance)
                        throws IllegalAccessException,
FieldNotAvailableException

Throws:

IllegalAccessException

FieldNotAvailableException