com.neurosys.modules.etl

Class EntityUpdateResUploadActionTransformer<T>

java.lang.Object

com.neurosys.modules.etl.EntityResourceUploadActionTransformer<T>

com.neurosys.modules.etl.EntityUpdateResUploadActionTransformer<T>

All Implemented Interfaces:

org.apache.commons.collections.Transformer

Direct Known Subclasses:

VelocityEntityUpdateResUploadActionTransformer

public abstract class EntityUpdateResUploadActionTransformer<T>
extends EntityResourceUploadActionTransformer<T>

Author:

Arjun Dhar

See Also:

EntityResourceUploadActionTransformer

Field Summary

Fields inherited from class com.neurosys.modules.etl.EntityResourceUploadActionTransformer

dao

Constructor Summary

Constructors

Constructor and Description
EntityUpdateResUploadActionTransformer()

Method Summary

Modifier and Type	Method and Description
protected abstract String	constructPath(T entity, Map context, FacetMeta fm, String path, int sequenceCode, List fieldValues)
protected String	derivePath(T entity, Map context, String path) Use the raw path to convert it to desired path, associate it with the entity; and return the same 'desired path'.
FacetMeta	getRelatedField() The FacetMeta for the field, in the entity that will be updated and sequence number derived (if FacetMeta.isCollectionType()). If the context provides it and this is null then the context FacetMeta (key name facetMeta), will be used.
FileUploadWrapper	getResourceUploader() Figure Web-relative paths for uploads etc from absolute path
protected int	getSequenceCode(List fieldValues) Default impl simply checks size.
Boolean	isRelatedFieldAsList() If true will convert paths into one comma separated String or else it will be a List.
protected String	relativePath(String renamedPath) By Default it converts an absolute path to a web relative URL (if the application settins are to store web relative paths instead of absolute ones)
void	setRelatedField(FacetMeta relatedField) The FacetMeta for the field, in the entity that will be updated and sequence number derived (if FacetMeta.isCollectionType()). If the context provides it and this is null then the context FacetMeta (key name facetMeta), will be used.
void	setRelatedFieldAsList(Boolean relatedFieldAsList) If true will convert paths into one comma separated String or else it will be a List.
void	setResourceUploader(FileUploadWrapper resourceUploader) Figure Web-relative paths for uploads etc from absolute path
protected String	validate(String renamedPath, T entity, Map context, FacetMeta fm, String path, int sequenceCode, List fieldValues) An opportunity to validate the renamedPath with the environment.

Methods inherited from class com.neurosys.modules.etl.EntityResourceUploadActionTransformer

getAction, getDao, getObjectIdNumberType, setAction, setDao, setObjectIdNumberType, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityUpdateResUploadActionTransformer

public EntityUpdateResUploadActionTransformer()

Method Detail

getSequenceCode

protected int getSequenceCode(List fieldValues)

Default impl simply checks size. This may cause conflicts if the first in the sequence is not 1 or the sequence is not consistent by an increment of 1.
Override to apply more sophisticated logic, to derive the sequence# in one go.

Parameters:

fieldValues - as List

Returns:

int

constructPath

protected abstract String constructPath(T entity,
                                        Map context,
                                        FacetMeta fm,
                                        String path,
                                        int sequenceCode,
                                        List fieldValues)

validate

protected String validate(String renamedPath,
                          T entity,
                          Map context,
                          FacetMeta fm,
                          String path,
                          int sequenceCode,
                          List fieldValues)
                   throws Exception

An opportunity to validate the renamedPath with the environment. If it does not work, either throw an Exception or provide a more suitable alternative. The path returned by this method will also be the one returned by the Transformer.

Parameters:

renamedPath - as String

entity - as T

context - as Map

fm - as FacetMeta

path - as original path String

sequenceCode - as int (proposed sequenceCode)

fieldValues - as List, the field values from the entity

Returns:

String as adjusted renamedPath

Throws:

Exception

relativePath

protected String relativePath(String renamedPath)
                       throws Exception

By Default it converts an absolute path to a web relative URL (if the application settins are to store web relative paths instead of absolute ones)

Parameters:

renamedPath -

Returns:

Throws:

Exception

derivePath

protected String derivePath(T entity,
                            Map context,
                            String path)
                     throws Exception

Use the raw path to convert it to desired path, associate it with the entity; and return the same 'desired path'.

Specified by:

derivePath in class EntityResourceUploadActionTransformer<T>

Parameters:

entity - as T

context - as Map

path - as String

Returns:

path as the new named path that is updated in the entity. (desired path)

Throws:

Exception

getRelatedField

public FacetMeta getRelatedField()

The FacetMeta for the field, in the entity that will be updated and sequence number derived (if FacetMeta.isCollectionType()).
If the context provides it and this is null then the context FacetMeta (key name facetMeta), will be used.

Can be null:

true

setRelatedField

public void setRelatedField(FacetMeta relatedField)

The FacetMeta for the field, in the entity that will be updated and sequence number derived (if FacetMeta.isCollectionType()).
If the context provides it and this is null then the context FacetMeta (key name facetMeta), will be used.

Can be null:

true

isRelatedFieldAsList

public Boolean isRelatedFieldAsList()

If true will convert paths into one comma separated String or else it will be a List.

Default value:

null .null implies it will rely on the default type of the field, in null field value and if this null it will assume it to be a String

setRelatedFieldAsList

public void setRelatedFieldAsList(Boolean relatedFieldAsList)

If true will convert paths into one comma separated String or else it will be a List.

Default value:

null .null implies it will rely on the default type of the field, in null field value and if this null it will assume it to be a String

getResourceUploader

public FileUploadWrapper getResourceUploader()

Figure Web-relative paths for uploads etc from absolute path

See Also:

FileUploadWrapper

setResourceUploader

public void setResourceUploader(FileUploadWrapper resourceUploader)

Figure Web-relative paths for uploads etc from absolute path

See Also:

FileUploadWrapper