com.foreach.across.modules.webcms.data

Class AbstractWebCmsDataImporter<T,U>

java.lang.Object

com.foreach.across.modules.webcms.data.AbstractWebCmsDataImporter<T,U>

All Implemented Interfaces:

WebCmsDataImporter

Direct Known Subclasses:

AbstractWebCmsAssetImporter, WebCmsComponentImporter, WebCmsDomainImporter, WebCmsMenuImporter, WebCmsRemoteEndpointImporter

public abstract class AbstractWebCmsDataImporter<T,U>
extends Object
implements WebCmsDataImporter

Abstract base class for a WebCmsDataImporter that needs to support both map and collection data, as well as the different WebCmsDataImportAction options.

Each entry to import is expected to represent a single object. Dispatches to the WebCmsPropertyDataImportService for custom property handling. If neither related property handlers have imported anything, nor values on the original asset have been changed, the asset will not be updated.

Since:

0.0.2

Author:

Arne Vandamme

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
AbstractWebCmsDataImporter()

Method Summary

Modifier and Type	Method and Description
protected void	addForceUpdateProperty(Map<String,Object> dataValues) Add force update property to a data values map.
protected boolean	applyDataValues(Map<String,Object> values, U dto) Apply the data values to the dto object.
protected abstract U	createDto(WebCmsDataEntry data, T existing, WebCmsDataAction action, Map<String,Object> dataValues) Create a DTO object for either a new instance or an existing instance.
protected abstract void	deleteInstance(T instance, WebCmsDataEntry data) Perform the delete action on existing instance.
void	importData(WebCmsDataEntry data) Import a single data entry from the original data set.
protected U	prepareForSaving(U itemToBeSaved, WebCmsDataEntry data) Override if you want to post process an item before saving.
protected WebCmsDataAction	resolveAction(WebCmsDataImportAction requested, T existing) Resolve the import action into the actual action to perform depending if there's an existing item we're dealing with or not.
protected WebCmsDomain	retrieveDomainForDataEntry(WebCmsDataEntry item, Class<?> entityType) Retrieves the current domain for the specified data entry and class.
protected abstract T	retrieveExistingInstance(WebCmsDataEntry data) Get the existing object that this data represents.
protected abstract void	saveDto(U dto, WebCmsDataAction action, WebCmsDataEntry data) Save an updated or created instance.
void	setPropertyDataImportService(WebCmsPropertyDataImportService propertyDataImportService)
protected void	validate(U itemToBeSaved, org.springframework.validation.Errors errors) Perform some custom validation on the item to be saved.
protected void	validateForSaving(U itemToSave) This performs validation by building an Errors object, and dispatching to the #validate(T, Errors) method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.foreach.across.modules.webcms.data.WebCmsDataImporter

supports

Field Detail

LOG

protected final org.slf4j.Logger LOG

Constructor Detail

AbstractWebCmsDataImporter

public AbstractWebCmsDataImporter()

Method Detail

importData

public final void importData(WebCmsDataEntry data)

Import a single data entry from the original data set. Depending on the original data set the single entry will have a key set or not. If the given data entry results in a new WebCmsDomainBound object, the domain will be prefilled with WebCmsMultiDomainService.getCurrentDomain()

Specified by:

importData in interface WebCmsDataImporter

Parameters:

data - to import

retrieveDomainForDataEntry

protected WebCmsDomain retrieveDomainForDataEntry(WebCmsDataEntry item,
                                                  Class<?> entityType)

Retrieves the current domain for the specified data entry and class. If the data entry contains a key, that domain will be returned. If the data entry does not contain a key, the domain will be retrieved using WebCmsMultiDomainService.getCurrentDomainForType(Class)

Parameters:

item - the data entry

entityType - to check domain support

Returns:

the domain to which the entity should be attached

applyDataValues

protected boolean applyDataValues(Map<String,Object> values,
                                  U dto)

Apply the data values to the dto object. The default implementation assumes that the values map with actual dto class properties.

If this method returns false no values have been applied to the DTO and actual updating might get skipped.

Parameters:

values - to apply (key/value pairs)

dto - to set the values on

Returns:

true if the DTO has been modified

resolveAction

protected WebCmsDataAction resolveAction(WebCmsDataImportAction requested,
                                         T existing)

Resolve the import action into the actual action to perform depending if there's an existing item we're dealing with or not. If this method returns null the processing of the data entry will be skipped.

Parameters:

requested - import action

existing - item or null if none

Returns:

action to perform or null if none

validateForSaving

protected final void validateForSaving(U itemToSave)

This performs validation by building an Errors object, and dispatching to the #validate(T, Errors) method. If actual validation errors are added, this will result in a validation exception.

Parameters:

itemToSave - item to be saved

prepareForSaving

protected U prepareForSaving(U itemToBeSaved,
                             WebCmsDataEntry data)

Override if you want to post process an item before saving. Useful if you want to generate property values for example.

Parameters:

itemToBeSaved - original item to be saved

data - that was used to build the item

Returns:

new item to be saved instead - null if saving should be skipped

validate

protected void validate(U itemToBeSaved,
                        org.springframework.validation.Errors errors)

Perform some custom validation on the item to be saved. If any errors are added to the collection, this will result in a validation exception being thrown.

Parameters:

itemToBeSaved - item to be saved

errors - collection to add validation errors to

retrieveExistingInstance

protected abstract T retrieveExistingInstance(WebCmsDataEntry data)

Get the existing object that this data represents. If no instance exists, this method should return null..

Parameters:

data - entry

Returns:

instance or null

createDto

protected abstract U createDto(WebCmsDataEntry data,
                               T existing,
                               WebCmsDataAction action,
                               Map<String,Object> dataValues)

Create a DTO object for either a new instance or an existing instance. If the existing parameter is null a new instance should be created.

Note that the DTO should not apply the data entry values yet, but the data entry can be used to determine the initial type of instance that needs to be created.

If the DTO is null, the import will be skipped but properties will still be called.

Parameters:

data - entry

existing - instance or null if a new instance should be created

action - purpose for which the DTO should be created (create, delete or replace)

dataValues - modifiable collection of the data values that will be applied afterwards

Returns:

DTO

deleteInstance

protected abstract void deleteInstance(T instance,
                                       WebCmsDataEntry data)

Perform the delete action on existing instance.

Parameters:

instance - to delete

data - entry that is being imported

saveDto

protected abstract void saveDto(U dto,
                                WebCmsDataAction action,
                                WebCmsDataEntry data)

Save an updated or created instance.

Parameters:

dto - that should be saved

action - type of save action (create, update or replace)

data - entry that is being imported

addForceUpdateProperty

protected final void addForceUpdateProperty(Map<String,Object> dataValues)

Add force update property to a data values map. This will cause the item to be updated, even if nothing else has changed. Mainly used in a REPLACE use case.

Parameters:

dataValues - map

setPropertyDataImportService

@Autowired
public void setPropertyDataImportService(WebCmsPropertyDataImportService propertyDataImportService)