FileToEntityLookup (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.modules.etl.FileToEntityLookup<T>

All Implemented Interfaces:

Lookup, ChangeGenerator<Object>, org.apache.commons.collections.Transformer

Direct Known Subclasses:

FileToProductLookup
```
public abstract class FileToEntityLookup<T>
extends Object
implements Lookup, ChangeGenerator<Object>
```
Based on a File, identify which Product it related to. Uses Query to run all Queries for matching.
This class will also generate Events of Type File or Object[]{List<T>, File}

Since this implements ChangeGenerator; it will also generate Events of Type
- File has matching entities - new Object[]{List of entities, File}
- No matching entities found - File
Author:

Arjun Dhar

Field Summary

Fields
Modifier and Type Field and Description

protected List<ChangeListener<Object>> listeners

Fields
Modifier and Type	Field and Description
`protected List<ChangeListener<Object>>`	`listeners`

Constructor Summary

Constructors
Constructor and Description

FileToEntityLookup()

FileToEntityLookup(FileToEntityLookup<T> parent)

Constructors
Constructor and Description
`FileToEntityLookup()`
`FileToEntityLookup(FileToEntityLookup<T> parent)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(ChangeListener<Object> changeListener)` Allow Notify all `ChangeListener`s about a change
`protected String`	`deriveIdRelatedInfo(File file)` Given a file, identify the related info.
`protected abstract List<T>`	`getEntities(Query<T> entityQuery)` Override to implement custom services that will execute the `Query` and return result(s)
`org.apache.commons.collections.Transformer`	`getExtractedNameTransformer()` Once the name is extracted from `extractionPattern` we can apply any custom `Transformer` over it before it is compared to the values in the database.
`Pattern`	`getExtractionPattern()` In a File name, extract part of the name that matches this pattern
`List`	`getListeners()` Get list directly.
`protected abstract T`	`getQueryInstance()` Construct Query Object; get base instance entity for `Query`
`String`	`getRelatedFieldName()` Field name of the entity to be looked up the extracted pattern will relate to This field should be `Queryable`
`void`	`notifyAllListeners(Object object)` Whenever a node is selected/updated, it also notifies its listeners.
`void`	`setExtractedNameTransformer(org.apache.commons.collections.Transformer extractedNameTransformer)` Once the name is extracted from `extractionPattern` we can apply any custom `Transformer` over it before it is compared to the values in the database.
`void`	`setExtractionPattern(Pattern extractionPattern)` In a File name, extract part of the name that matches this pattern
`void`	`setListeners(List listeners)` Set list directly.
`void`	`setRelatedFieldName(String relatedFieldName)` Field name of the entity to be looked up the extracted pattern will relate to This field should be `Queryable`
`Object`	`transform(Object in)` For a Given String, Lookup a value for it

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

- Field Detail
  - listeners
```
protected transient List<ChangeListener<Object>> listeners
```
- Constructor Detail
  - FileToEntityLookup
```
public FileToEntityLookup()
```
  - FileToEntityLookup
```
public FileToEntityLookup(FileToEntityLookup<T> parent)
                   throws IllegalAccessException,
                          InvocationTargetException,
                          NoSuchMethodException
```
    Throws:
    
    IllegalAccessException
    
    InvocationTargetException
    
    NoSuchMethodException
- Method Detail
  - deriveIdRelatedInfo
```
protected String deriveIdRelatedInfo(File file)
```
    Given a file, identify the related info. Like Code embedded in the file name and/or path which will tie to an Id in a product.
    
    Parameters:
    
    file - as File
    
    Returns:
    
    String
  - getQueryInstance
```
protected abstract T getQueryInstance()
                               throws Exception
```
    Construct Query Object; get base instance entity for Query
    
    Returns:
    
    Throws:
    
    Exception
  - transform
```
public Object transform(Object in)
```
    Description copied from interface: Lookup
    
    For a Given String, Lookup a value for it
    
    Specified by:
    
    transform in interface Lookup
    
    Specified by:
    
    transform in interface org.apache.commons.collections.Transformer
  - getEntities
```
protected abstract List<T> getEntities(Query<T> entityQuery)
                                throws Exception
```
    Override to implement custom services that will execute the Query and return result(s)
    
    Parameters:
    
    entityQuery - as Query
    
    Returns:
    
    Throws:
    
    Exception
  - getExtractionPattern
```
public Pattern getExtractionPattern()
```
    In a File name, extract part of the name that matches this pattern
  - setExtractionPattern
```
public void setExtractionPattern(Pattern extractionPattern)
```
    In a File name, extract part of the name that matches this pattern
  - getRelatedFieldName
```
public String getRelatedFieldName()
```
    Field name of the entity to be looked up the extracted pattern will relate to
    This field should be Queryable
  - setRelatedFieldName
```
public void setRelatedFieldName(String relatedFieldName)
```
    Field name of the entity to be looked up the extracted pattern will relate to
    This field should be Queryable
  - getExtractedNameTransformer
```
public org.apache.commons.collections.Transformer getExtractedNameTransformer()
```
    Once the name is extracted from extractionPattern we can apply any custom Transformer over it before it is compared to the values in the database.
  - setExtractedNameTransformer
```
public void setExtractedNameTransformer(org.apache.commons.collections.Transformer extractedNameTransformer)
```
    Once the name is extracted from extractionPattern we can apply any custom Transformer over it before it is compared to the values in the database.
  - addChangeListener
```
public void addChangeListener(ChangeListener<Object> changeListener)
```
    Description copied from interface: ChangeGenerator
    
    Allow Notify all ChangeListeners about a change
    
    Specified by:
    
    addChangeListener in interface ChangeGenerator<Object>
  - notifyAllListeners
```
public void notifyAllListeners(Object object)
```
    Description copied from interface: ChangeGenerator
    
    Whenever a node is selected/updated, it also notifies its listeners.
    
    Specified by:
    
    notifyAllListeners in interface ChangeGenerator<Object>
  - getListeners
```
public List getListeners()
```
    Description copied from interface: ChangeGenerator
    
    Get list directly. Support DI; like Spring IOC
    
    Specified by:
    
    getListeners in interface ChangeGenerator<Object>
  - setListeners
```
public void setListeners(List listeners)
```
    Description copied from interface: ChangeGenerator
    
    Set list directly. Support DI; like Spring IOC
    
    Specified by:
    
    setListeners in interface ChangeGenerator<Object>

Class FileToEntityLookup<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

listeners

Constructor Detail

FileToEntityLookup

FileToEntityLookup

Method Detail

deriveIdRelatedInfo

getQueryInstance

transform

getEntities

getExtractionPattern

setExtractionPattern

getRelatedFieldName

setRelatedFieldName

getExtractedNameTransformer

setExtractedNameTransformer

addChangeListener

notifyAllListeners

getListeners

setListeners