com.foreach.across.modules.webcms.domain.asset

Class AbstractWebCmsAssetImporter<T extends WebCmsAsset>

java.lang.Object

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

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

All Implemented Interfaces:

WebCmsDataImporter

Direct Known Subclasses:

WebCmsArticleImporter, WebCmsPageImporter, WebCmsPublicationImporter

public abstract class AbstractWebCmsAssetImporter<T extends WebCmsAsset>
extends AbstractWebCmsDataImporter<T,T>

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

Since:

0.0.1

Author:

Arne Vandamme

Field Summary

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

LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWebCmsAssetImporter(@NonNull String dataKey, @NonNull Class<T> assetType)

Method Summary

Modifier and Type	Method and Description
protected void	deleteInstance(T instance, WebCmsDataEntry data) Perform the delete action on existing instance.
protected T	getExistingEntity(String entryKey, WebCmsDataEntry entryData, 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 T	retrieveExistingInstance(WebCmsDataEntry item) Get the existing object that this data represents.
protected void	saveDto(T itemToSave, WebCmsDataAction action, WebCmsDataEntry data) Save an updated or created instance.
void	setAssetRepository(WebCmsAssetRepository assetRepository)
boolean	supports(WebCmsDataEntry data)
protected void	validateObjectId(String objectId) Should validate the object id for the asset type requested.

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

addForceUpdateProperty, applyDataValues, createDto, importData, prepareForSaving, resolveAction, retrieveDomainForDataEntry, setPropertyDataImportService, validate, validateForSaving

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWebCmsAssetImporter

protected AbstractWebCmsAssetImporter(@NonNull
                                      @NonNull String dataKey,
                                      @NonNull
                                      @NonNull Class<T> assetType)

Method Detail

supports

public final boolean supports(WebCmsDataEntry data)

retrieveExistingInstance

protected final T retrieveExistingInstance(WebCmsDataEntry item)

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<T extends WebCmsAsset,T extends WebCmsAsset>

Parameters:

item - entry

Returns:

instance or null

validateObjectId

protected void validateObjectId(String objectId)

Should validate the object id for the asset type requested. Will throw an exception if an object id is specified but it is not of valid form for the asset type.

deleteInstance

protected void deleteInstance(T instance,
                              WebCmsDataEntry data)

Description copied from class: AbstractWebCmsDataImporter

Perform the delete action on existing instance.

Specified by:

deleteInstance in class AbstractWebCmsDataImporter<T extends WebCmsAsset,T extends WebCmsAsset>

Parameters:

instance - to delete

data - entry that is being imported

saveDto

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

Description copied from class: AbstractWebCmsDataImporter

Save an updated or created instance.

Specified by:

saveDto in class AbstractWebCmsDataImporter<T extends WebCmsAsset,T extends WebCmsAsset>

Parameters:

itemToSave - that should be saved

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

data - entry that is being imported

getExistingEntity

protected T getExistingEntity(String entryKey,
                              WebCmsDataEntry entryData,
                              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.

Parameters:

entryKey - for the asset

entryData - for he asset

domain - for the asset

Returns:

existing entity or null

setAssetRepository

@Autowired
public void setAssetRepository(WebCmsAssetRepository assetRepository)