com.foreach.across.modules.webcms.domain.component

Class WebCmsComponentImporter

java.lang.Object

com.foreach.across.modules.webcms.data.AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

com.foreach.across.modules.webcms.domain.component.WebCmsComponentImporter

All Implemented Interfaces:

WebCmsDataImporter

@Component
 @Scope(value="prototype")
public class WebCmsComponentImporter
extends AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

Base class for importing a simple asset type. An asset has a specific data key (in the asset collection) and a class extending WebCmsComponent.

Since:

0.0.1

Author:

Arne Vandamme

Field Summary

Fields inherited from class com.foreach.across.modules.webcms.data.AbstractWebCmsDataImporter

LOG

Constructor Summary

Constructors

Constructor and Description
WebCmsComponentImporter()

Method Summary

Modifier and Type	Method and Description
protected boolean	applyDataValues(Map<String,Object> values, WebCmsComponentModel dto) Apply the data values to the dto object.
protected WebCmsComponentModel	createDto(WebCmsDataEntry data, WebCmsComponentModel itemToUpdate, WebCmsDataAction action, Map<String,Object> dataValues) Create a DTO object for either a new instance or an existing instance.
protected void	deleteInstance(WebCmsComponentModel instance, WebCmsDataEntry data) Perform the delete action on existing instance.
protected WebCmsComponentModel	prepareForSaving(WebCmsComponentModel itemToBeSaved, WebCmsDataEntry data) Override if you want to post process an item before saving.
protected WebCmsComponentModel	retrieveExistingInstance(WebCmsDataEntry data) Get the existing object that this data represents.
protected void	saveDto(WebCmsComponentModel itemToSave, WebCmsDataAction action, WebCmsDataEntry data) Save an updated or created instance.
void	setOwner(WebCmsObject owner) Set the owner of the objects being created.
boolean	supports(WebCmsDataEntry data)
protected void	validate(WebCmsComponentModel itemToBeSaved, org.springframework.validation.Errors errors) Perform some custom validation on the item to be saved.

Methods inherited from class com.foreach.across.modules.webcms.data.AbstractWebCmsDataImporter

addForceUpdateProperty, importData, resolveAction, retrieveDomainForDataEntry, setPropertyDataImportService, validateForSaving

Methods inherited from class java.lang.Object

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

Constructor Detail

WebCmsComponentImporter

public WebCmsComponentImporter()

Method Detail

supports

public final boolean supports(WebCmsDataEntry data)

retrieveExistingInstance

protected WebCmsComponentModel retrieveExistingInstance(WebCmsDataEntry data)

Description copied from class: AbstractWebCmsDataImporter

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

Specified by:

retrieveExistingInstance in class AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

Parameters:

data - entry

Returns:

instance or null

createDto

protected WebCmsComponentModel createDto(WebCmsDataEntry data,
                                         WebCmsComponentModel itemToUpdate,
                                         WebCmsDataAction action,
                                         Map<String,Object> dataValues)

Description copied from class: AbstractWebCmsDataImporter

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.

Specified by:

createDto in class AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

Parameters:

data - entry

itemToUpdate - 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 void deleteInstance(WebCmsComponentModel instance,
                              WebCmsDataEntry data)

Description copied from class: AbstractWebCmsDataImporter

Perform the delete action on existing instance.

Specified by:

deleteInstance in class AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

Parameters:

instance - to delete

data - entry that is being imported

prepareForSaving

protected WebCmsComponentModel prepareForSaving(WebCmsComponentModel itemToBeSaved,
                                                WebCmsDataEntry data)

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

Overrides:

prepareForSaving in class AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

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

saveDto

protected void saveDto(WebCmsComponentModel itemToSave,
                       WebCmsDataAction action,
                       WebCmsDataEntry data)

Description copied from class: AbstractWebCmsDataImporter

Save an updated or created instance.

Specified by:

saveDto in class AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

Parameters:

itemToSave - that should be saved

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

data - entry that is being imported

applyDataValues

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

Description copied from class: AbstractWebCmsDataImporter

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.

Overrides:

applyDataValues in class AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

Parameters:

values - to apply (key/value pairs)

dto - to set the values on

Returns:

true if the DTO has been modified

setOwner

public void setOwner(WebCmsObject owner)

Set the owner of the objects being created.

validate

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

Description copied from class: AbstractWebCmsDataImporter

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.

Overrides:

validate in class AbstractWebCmsDataImporter<WebCmsComponentModel,WebCmsComponentModel>

Parameters:

itemToBeSaved - item to be saved

errors - collection to add validation errors to