FieldTransformer (Data Pipeline JavaDoc)

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)

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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)` Applies this transformer to a record on its way through a `TransformingReader` or `TransformingWriter`.
`protected abstract void`	`transformField(Field field)`

Methods inherited from class com.northconcepts.datapipeline.transform.Transformer
close, geEndpoint, getEndpoint, getReader, getWriter, of, 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
```
    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
  - 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

Class FieldTransformer

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

FieldTransformer

FieldTransformer

FieldTransformer

Method Detail

getName

getNames

getNamesAsStrings

isThrowExceptionOnMissingField

setThrowExceptionOnMissingField

getCurrentRecord

getCurrentField

setValueOnException

getValueOnException

hasValueOnException

transform

transformField

toString

addExceptionProperties