FileToProductsTransformer (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.etl.process.EventAwareProcess
- - com.neurosys.modules.etl.FileToProductsTransformer<P>

All Implemented Interfaces:

ModeAware, SourceAware, Process, Serializable, org.apache.commons.collections.Transformer

Direct Known Subclasses:

FileToProductsTransformer
```
public class FileToProductsTransformer<P extends Product>
extends EventAwareProcess
implements SourceAware, org.apache.commons.collections.Transformer
```
Allow to update an existing Entitie(s) i.e. a List; with Images/Documents and associating them to the entity. (File System to entity mapping)
If ModeAware.getMode() is Mode.UPDATE and the FacetMeta.isCollectionType() then it will append existing data instead of replacing it.

Note: All changes made to entities are in memory; this class will not PERSIST the changes made by the Transformer

Is SourceAware and hence ModeAware. TODO: Add unit test case

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.neurosys.etl.process.Process
  Process.Event, Process.EventPoint

Field Summary

Fields
Modifier and Type	Field and Description
`protected FacetMeta`	`contentFacet` The `FacetMeta` in the Content the file will relate to
`protected Lookup`	`entitiesLookup` Uses this as to extract the entities (List) from the raw input type, that relate to the input
`protected org.apache.commons.collections.Predicate`	`filter` Filter Raw input and ensure its eligible for Transformation
`protected Mode`	`mode`
`protected List<Mode>`	`modesSupported` What all modes does this Reader support Default All defined in `Mode`
`protected boolean`	`order` If true then order the file names in case an array is used
`protected org.apache.commons.collections.Transformer`	`pathTransformer` For the given File/resource; derive the appropriate path to the resource
`protected boolean`	`unique` If true then file names are unique in case an array is used

Fields inherited from class com.neurosys.etl.process.EventAwareProcess
listeners, processState

Constructor Summary

Constructors
Constructor and Description

FileToProductsTransformer()

Constructors
Constructor and Description
`FileToProductsTransformer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FacetMeta`	`getContentFacet()` The `FacetMeta` in the Content the file will relate to
`Lookup`	`getEntitiesLookup()` Uses this as to extract the entities (List) from the raw input type, that relate to the input
`org.apache.commons.collections.Predicate`	`getFilter()` Filter Raw input and ensure its elegible for `Transformer`ation
`Mode`	`getMode()` The processing logic of the Reader may differ based n the fact it is intended to Update or Insert or Delete
`List<Mode>`	`getModesSupported()` Get the `Mode`s supported by the instance
`org.apache.commons.collections.Transformer`	`getPathTransformer()` For the given File/resource; derive the appropriate path to the resource
`boolean`	`isOrder()` If true then order the file names in case an array is used
`boolean`	`isUnique()` If true then file names are unique in case an array is used
`void`	`setContentFacet(FacetMeta contentFacet)` The `FacetMeta` in the Content the file will relate to
`void`	`setEntitiesLookup(Lookup entitiesLookup)` Uses this as to extract the entities (List) from the raw input type, that relate to the input
`void`	`setFilter(org.apache.commons.collections.Predicate filter)` Filter Raw input and ensure its elegible for `Transformer`ation
`void`	`setMode(Mode mode)`
`void`	`setModesSupported(List<Mode> modesSupported)`
`void`	`setOrder(boolean order)` If true then order the file names in case an array is used
`void`	`setPathTransformer(org.apache.commons.collections.Transformer pathTransformer)` For the given File/resource; derive the appropriate path to the resource
`void`	`setUnique(boolean unique)` If true then file names are unique in case an array is used
`Object`	`transform(Object input)`
`protected String`	`updateList(String existingAttributeValue)` The list of file names for a given product.

Methods inherited from class com.neurosys.etl.process.EventAwareProcess
addListener, getListeners, onChangeHandler, setListeners

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mode
```
protected Mode mode
```
  - filter
```
protected org.apache.commons.collections.Predicate filter
```
    Filter Raw input and ensure its eligible for Transformation
    
    Can be null:
    
    true
  - entitiesLookup
```
protected Lookup entitiesLookup
```
    Uses this as to extract the entities (List) from the raw input type, that relate to the input
  - pathTransformer
```
protected org.apache.commons.collections.Transformer pathTransformer
```
    For the given File/resource; derive the appropriate path to the resource
  - contentFacet
```
protected FacetMeta contentFacet
```
    The FacetMeta in the Content the file will relate to
  - order
```
protected boolean order
```
    If true then order the file names in case an array is used
  - unique
```
protected boolean unique
```
    If true then file names are unique in case an array is used
  - modesSupported
```
protected List<Mode> modesSupported
```
    What all modes does this Reader support
    Default All defined in Mode
- Constructor Detail
  - FileToProductsTransformer
```
public FileToProductsTransformer()
```
- Method Detail
  - updateList
```
protected String updateList(String existingAttributeValue)
```
    The list of file names for a given product.
    With each new discovery this list will be updated and contain the cumulative fiel names so far associated with the product.
    
    One can sort, filter etc the list
    By default, if order is true then it is sorted
    
    Parameters:
    
    list -
  - transform
```
@Transactional(readOnly=false)
public Object transform(Object input)
```
    Specified by:
    
    transform in interface org.apache.commons.collections.Transformer
  - getMode
```
public Mode getMode()
```
    Description copied from interface: ModeAware
    
    The processing logic of the Reader may differ based n the fact it is intended to Update or Insert or Delete
    
    Specified by:
    
    getMode in interface ModeAware
    
    See Also:
    
    Mode
    
    Default value:
    
    Mode.UPDATE
  - setMode
```
public void setMode(Mode mode)
```
    Specified by:
    
    setMode in interface ModeAware
    
    Default value:
    
    Mode.UPDATE
  - getFilter
```
public org.apache.commons.collections.Predicate getFilter()
```
    Filter Raw input and ensure its elegible for Transformeration
    
    Can be null:
    
    true
  - setFilter
```
public void setFilter(org.apache.commons.collections.Predicate filter)
```
    Filter Raw input and ensure its elegible for Transformeration
    
    Can be null:
    
    true
  - getEntitiesLookup
```
public Lookup getEntitiesLookup()
```
    Uses this as to extract the entities (List) from the raw input type, that relate to the input
  - setEntitiesLookup
```
public void setEntitiesLookup(Lookup entitiesLookup)
```
    Uses this as to extract the entities (List) from the raw input type, that relate to the input
  - getContentFacet
```
public FacetMeta getContentFacet()
```
    The FacetMeta in the Content the file will relate to
  - setContentFacet
```
public void setContentFacet(FacetMeta contentFacet)
```
    The FacetMeta in the Content the file will relate to
  - getPathTransformer
```
public org.apache.commons.collections.Transformer getPathTransformer()
```
    For the given File/resource; derive the appropriate path to the resource
  - setPathTransformer
```
public void setPathTransformer(org.apache.commons.collections.Transformer pathTransformer)
```
    For the given File/resource; derive the appropriate path to the resource
  - getModesSupported
```
public List<Mode> getModesSupported()
```
    Description copied from interface: ModeAware
    
    Get the Modes supported by the instance
    
    Specified by:
    
    getModesSupported in interface ModeAware
    
    Returns:
  - setModesSupported
```
public void setModesSupported(List<Mode> modesSupported)
```
  - isOrder
```
public boolean isOrder()
```
    If true then order the file names in case an array is used
  - setOrder
```
public void setOrder(boolean order)
```
    If true then order the file names in case an array is used
  - isUnique
```
public boolean isUnique()
```
    If true then file names are unique in case an array is used
  - setUnique
```
public void setUnique(boolean unique)
```
    If true then file names are unique in case an array is used

Class FileToProductsTransformer<P extends Product>

Nested Class Summary

Nested classes/interfaces inherited from interface com.neurosys.etl.process.Process

Field Summary

Fields inherited from class com.neurosys.etl.process.EventAwareProcess

Constructor Summary

Method Summary

Methods inherited from class com.neurosys.etl.process.EventAwareProcess

Methods inherited from class java.lang.Object

Field Detail

mode

filter

entitiesLookup

pathTransformer

contentFacet

order

unique

modesSupported

Constructor Detail

FileToProductsTransformer

Method Detail

updateList

transform

getMode

setMode

getFilter

setFilter

getEntitiesLookup

setEntitiesLookup

getContentFacet

setContentFacet

getPathTransformer

setPathTransformer

getModesSupported

setModesSupported

isOrder

setOrder

isUnique

setUnique