com.northconcepts.datapipeline.transform

Class FieldTransformer

java.lang.Object

com.northconcepts.datapipeline.transform.Transformer

com.northconcepts.datapipeline.transform.FieldTransformer

Direct Known Subclasses:

BasicFieldTransformer

public abstract class FieldTransformer
extends Transformer

See FieldPath for supported field name expressions.

Constructor Summary

Constructors

Constructor and Description
FieldTransformer(Collection<String> names)
FieldTransformer(String... names)
FieldTransformer(String name)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception)
Field	getCurrentField()
Record	getCurrentRecord()
String	getName() Returns the name of the field this transformer applies to if only one field was specified, otherwise null if multiple fields.
FieldPath[]	getNames()
String[]	getNamesAsStrings()
Object	getValueOnException()
boolean	hasValueOnException()
boolean	isThrowExceptionOnMissingField() Indicates if an exception should be thrown if the source field is missing (default to true).
FieldTransformer	setThrowExceptionOnMissingField(boolean throwExceptionOnMissingField) Indicates if an exception should be thrown if the source field is missing (default to true).
FieldTransformer	setValueOnException(Object valueOnException)
String	toString()
boolean	transform(Record record)
protected abstract void	transformField(Field field)

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

close, geEndpoint, getEndpoint, getReader, getWriter, open, setWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldTransformer

public FieldTransformer(String... names)

FieldTransformer

public FieldTransformer(String name)

FieldTransformer

public FieldTransformer(Collection<String> names)

Method Detail

getName

public String getName()

Returns the name of the field this transformer applies to if only one field was specified, otherwise null if multiple fields.

See Also:

getNames(), getNamesAsStrings()

getNames

public FieldPath[] getNames()

getNamesAsStrings

public String[] getNamesAsStrings()

isThrowExceptionOnMissingField

public boolean isThrowExceptionOnMissingField()

Indicates if an exception should be thrown if the source field is missing (default to true).

setThrowExceptionOnMissingField

public FieldTransformer setThrowExceptionOnMissingField(boolean throwExceptionOnMissingField)

Indicates if an exception should be thrown if the source field is missing (default to true).

getCurrentRecord

public Record getCurrentRecord()

getCurrentField

public Field getCurrentField()

setValueOnException

public FieldTransformer setValueOnException(Object valueOnException)

getValueOnException

public Object getValueOnException()

hasValueOnException

public boolean hasValueOnException()

transform

public boolean transform(Record record)
                  throws Throwable

Specified by:

transform in class Transformer

Throws:

Throwable

transformField

protected abstract void transformField(Field field)
                                throws Throwable

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Overrides:

addExceptionProperties in class Transformer