com.northconcepts.datapipeline.transform.lookup

Class LookupTransformer

java.lang.Object

com.northconcepts.datapipeline.transform.Transformer

com.northconcepts.datapipeline.transform.lookup.LookupTransformer

public class LookupTransformer
extends Transformer

Constructor Summary

Constructors

Constructor and Description
LookupTransformer(FieldList fields, Lookup lookup)
LookupTransformer(FieldList fields, Lookup lookup, boolean overwriteFields) Deprecated.
LookupTransformer(FieldList fields, Lookup lookup, Node.DuplicateNodeAction duplicateFieldAction)

Method Summary

Modifier and Type	Method and Description
protected void	close() Called by TransformingReader or TransformingWriter when their close() method is called (after reading or writing ends).
Node.DuplicateNodeAction	getDuplicateFieldAction()
FieldList	getFields()
Lookup	getLookup()
boolean	isAllowNoResults() Indicates if no exception should be thrown if no results are found (default false, exceptions are thrown).
boolean	isOverwriteFields()
protected void	join(Record originalRecord, RecordList lookupResult, List<?> lookupArguments)
protected RecordList	noResults(Record originalRecord, List<?> arguments)
protected void	open() Called by TransformingReader or TransformingWriter when their open() method is called (before reading or writing starts).
LookupTransformer	setAllowNoResults(boolean allowNoResults) Indicates if no exception should be thrown if no results are found (default false, exceptions are thrown).
LookupTransformer	setDuplicateFieldAction(Node.DuplicateNodeAction duplicateFieldAction)
protected RecordList	tooManyResults(Record originalRecord, List<?> arguments, RecordList lookupResult)
String	toString()
boolean	transform(Record record) Applies this transformer to a record on its way through a TransformingReader or TransformingWriter.

Methods inherited from class com.northconcepts.datapipeline.transform.Transformer

addExceptionProperties, geEndpoint, getEndpoint, getReader, getWriter, of, setWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupTransformer

public LookupTransformer(FieldList fields,
                         Lookup lookup,
                         Node.DuplicateNodeAction duplicateFieldAction)

LookupTransformer

@Deprecated
public LookupTransformer(FieldList fields,
                                     Lookup lookup,
                                     boolean overwriteFields)

Deprecated.

LookupTransformer

public LookupTransformer(FieldList fields,
                         Lookup lookup)

Method Detail

getFields

public FieldList getFields()

getLookup

public Lookup getLookup()

getDuplicateFieldAction

public Node.DuplicateNodeAction getDuplicateFieldAction()

setDuplicateFieldAction

public LookupTransformer setDuplicateFieldAction(Node.DuplicateNodeAction duplicateFieldAction)

isOverwriteFields

public boolean isOverwriteFields()

isAllowNoResults

public boolean isAllowNoResults()

Indicates if no exception should be thrown if no results are found (default false, exceptions are thrown).

setAllowNoResults

public LookupTransformer setAllowNoResults(boolean allowNoResults)

Indicates if no exception should be thrown if no results are found (default false, exceptions are thrown).

open

protected void open()

Description copied from class: Transformer

Called by TransformingReader or TransformingWriter when their open() method is called (before reading or writing starts).

Overrides:

open in class Transformer

close

protected void close()

Description copied from class: Transformer

Called by TransformingReader or TransformingWriter when their close() method is called (after reading or writing ends).

Overrides:

close in class Transformer

transform

public boolean transform(Record record)
                  throws Throwable

Description copied from class: Transformer

Applies this transformer to a record on its way through a TransformingReader or TransformingWriter.

Contract for subclasses (see also docs/authoring/Transformer.md):

• Mutate record in place as needed.
• Return true to keep the record in the pipeline.
• Return false to drop the record (the host routes it to a discard writer if one is configured, otherwise it disappears).
• Throw to fail (or route to a discard writer, depending on host configuration).
• Do not call incrementRecordCount() on the host endpoint; the host handles it.

Specified by:

transform in class Transformer

Throws:

Throwable

join

protected void join(Record originalRecord,
                    RecordList lookupResult,
                    List<?> lookupArguments)

noResults

protected RecordList noResults(Record originalRecord,
                               List<?> arguments)

tooManyResults

protected RecordList tooManyResults(Record originalRecord,
                                    List<?> arguments,
                                    RecordList lookupResult)

toString

public String toString()

Overrides:

toString in class Object