com.foreach.across.modules.webcms.domain.menu

Class WebCmsMenuImporter

java.lang.Object

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

com.foreach.across.modules.webcms.domain.menu.WebCmsMenuImporter

All Implemented Interfaces:

WebCmsDataImporter

@Component
public class WebCmsMenuImporter
extends AbstractWebCmsDataImporter<WebCmsMenu,WebCmsMenu>

Creates one (or many) @WebCmsMenus from a yml file

Since:

0.0.2

Author:

Raf Ceuls

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor and Description
WebCmsMenuImporter()

Method Summary

Modifier and Type	Method and Description
protected boolean	applyDataValues(Map<String,Object> values, WebCmsMenu dto) Apply the data values to the dto object.
protected WebCmsMenu	createDto(WebCmsDataEntry data, WebCmsMenu existing, WebCmsDataAction action, Map<String,Object> dataValues) Create a DTO object for either a new instance or an existing instance.
protected void	deleteInstance(WebCmsMenu instance, WebCmsDataEntry data) Perform the delete action on existing instance.
protected WebCmsMenu	retrieveExistingInstance(WebCmsDataEntry data) Get the existing object that this data represents.
protected void	saveDto(WebCmsMenu dto, WebCmsDataAction action, WebCmsDataEntry data) Save an updated or created instance.
boolean	supports(WebCmsDataEntry data)
protected void	validate(WebCmsMenu 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, prepareForSaving, resolveAction, retrieveDomainForDataEntry, setPropertyDataImportService, validateForSaving

Methods inherited from class java.lang.Object

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

Constructor Detail

WebCmsMenuImporter

public WebCmsMenuImporter()

Method Detail

supports

public boolean supports(WebCmsDataEntry data)

retrieveExistingInstance

protected WebCmsMenu 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<WebCmsMenu,WebCmsMenu>

Parameters:

data - entry

Returns:

instance or null

createDto

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

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

applyDataValues

protected boolean applyDataValues(Map<String,Object> values,
                                  WebCmsMenu 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<WebCmsMenu,WebCmsMenu>

Parameters:

values - to apply (key/value pairs)

dto - to set the values on

Returns:

true if the DTO has been modified

deleteInstance

protected void deleteInstance(WebCmsMenu instance,
                              WebCmsDataEntry data)

Description copied from class: AbstractWebCmsDataImporter

Perform the delete action on existing instance.

Specified by:

deleteInstance in class AbstractWebCmsDataImporter<WebCmsMenu,WebCmsMenu>

Parameters:

instance - to delete

data - entry that is being imported

saveDto

protected void saveDto(WebCmsMenu dto,
                       WebCmsDataAction action,
                       WebCmsDataEntry data)

Description copied from class: AbstractWebCmsDataImporter

Save an updated or created instance.

Specified by:

saveDto in class AbstractWebCmsDataImporter<WebCmsMenu,WebCmsMenu>

Parameters:

dto - that should be saved

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

data - entry that is being imported

validate

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

Parameters:

itemToBeSaved - item to be saved

errors - collection to add validation errors to