com.foreach.across.modules.webcms.domain.page

Class WebCmsPageImporter

java.lang.Object

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

com.foreach.across.modules.webcms.domain.asset.AbstractWebCmsAssetImporter<WebCmsPage>

com.foreach.across.modules.webcms.domain.page.WebCmsPageImporter

All Implemented Interfaces:

WebCmsDataImporter

@Component
public final class WebCmsPageImporter
extends AbstractWebCmsAssetImporter<WebCmsPage>

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

Method Summary

Modifier and Type	Method and Description
protected WebCmsPage	createDto(WebCmsDataEntry data, WebCmsPage itemToUpdate, WebCmsDataAction action, Map<String,Object> dataValues) Create a DTO object for either a new instance or an existing instance.
protected WebCmsPage	getExistingEntity(String entryKey, WebCmsDataEntry data, WebCmsDomain domain) If no asset has been found by the unique asset key and domain combination (or no asset key was defined), this method will be called with the entry key.
protected WebCmsPage	prepareForSaving(WebCmsPage itemToBeSaved, WebCmsDataEntry data) Override if you want to post process an item before saving.
protected void	validate(WebCmsPage 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.domain.asset.AbstractWebCmsAssetImporter

deleteInstance, retrieveExistingInstance, saveDto, setAssetRepository, supports, validateObjectId

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

addForceUpdateProperty, applyDataValues, 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

WebCmsPageImporter

public WebCmsPageImporter()

Method Detail

createDto

protected WebCmsPage createDto(WebCmsDataEntry data,
                               WebCmsPage 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<WebCmsPage,WebCmsPage>

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

prepareForSaving

protected WebCmsPage prepareForSaving(WebCmsPage itemToBeSaved,
                                      WebCmsDataEntry data)

Description copied from class: AbstractWebCmsDataImporter

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<WebCmsPage,WebCmsPage>

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

getExistingEntity

protected WebCmsPage getExistingEntity(String entryKey,
                                       WebCmsDataEntry data,
                                       WebCmsDomain domain)

Description copied from class: AbstractWebCmsAssetImporter

If no asset has been found by the unique asset key and domain combination (or no asset key was defined), this method will be called with the entry key.

Overrides:

getExistingEntity in class AbstractWebCmsAssetImporter<WebCmsPage>

Parameters:

entryKey - for the asset

data - for he asset

domain - for the asset

Returns:

existing entity or null

validate

protected void validate(WebCmsPage 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<WebCmsPage,WebCmsPage>

Parameters:

itemToBeSaved - item to be saved

errors - collection to add validation errors to