java.lang.Object

com.northconcepts.datapipeline.transform.BasicFieldTransformer.Operation

com.northconcepts.datapipeline.transform.BasicFieldTransformer.SingleValueOperation

All Implemented Interfaces:: INodeVisitor

Direct Known Subclasses:: BasicFieldTransformer.StringOperation

Enclosing class:: BasicFieldTransformer

public abstract static class BasicFieldTransformer.SingleValueOperation extends BasicFieldTransformer.Operation implements INodeVisitor

An BasicFieldTransformer.Operation applied to each single value in a field, including array elements and values in nested records.

Field Summary

Fields

Modifier and Type

Field

Description

protected boolean

applyToNulls

protected final FieldType

returnType
Constructor Summary

Constructors

Constructor

Description

SingleValueOperation(String name, FieldType returnType)

Creates an operation that skips null values, only retyping them as nulls of returnType.

SingleValueOperation(String name, FieldType returnType, boolean applyToNulls)

Creates an operation that stores null results as nulls of returnType; null values reach applyImpl only if applyToNulls is true (otherwise they are just retyped).
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this operation's details to an exception raised while it runs; returns the same exception.

protected final void

apply(Field field)

Applies this operation to the field, updating its value in place.

protected abstract Object

applyImpl(SingleValue input)

Returns the replacement for input; return input itself to leave it unchanged or null to store a null of returnType.

protected void

applyToArrayValue(ArrayValue array, int index, SingleValue input)

Applies applyImpl to the array element at the 0-based index and stores the result in the array.

protected void

applyToFieldValue(Field field, SingleValue input)

Applies applyImpl to a field's single value and stores the result in the field.

protected void

applyToNullArray(ArrayValue array)

final void

endArray(ArrayValue array)

Called after all of the array's elements have been visited.

final void

endArrayValue(ArrayValue array, int index, ValueNode<?> value)

Called after the element at the given 0-based index has been visited.

final void

endField(Field field)

Called last for a field, after INodeVisitor.endFieldValue(Field, ValueNode).

final void

endFieldValue(Field field, ValueNode<?> value)

Called after the field's value node has been visited.

final void

endRecord(Record record)

Called after all of the record's fields have been visited.

final void

singleValue(SingleValue value)

Called for each single (leaf) value; it has no matching end callback.

final void

startArray(ArrayValue array)

Called before the array's elements are visited.

final void

startArrayValue(ArrayValue array, int index, ValueNode<?> value)

Called before the element at the given 0-based index is visited.

final void

startField(Field field)

Called when a field is reached, before INodeVisitor.startFieldValue(Field, ValueNode).

final void

startFieldValue(Field field, ValueNode<?> value)

Called before the field's value node is visited.

final void

startRecord(Record record)

Called before the record's fields are visited.

Methods inherited from class com.northconcepts.datapipeline.transform.BasicFieldTransformer.Operation
toString

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

Field Details
- returnType
  
  protected final FieldType returnType
- applyToNulls
  
  protected boolean applyToNulls
Constructor Details
- SingleValueOperation
  
  public SingleValueOperation(String name, FieldType returnType, boolean applyToNulls)
  
  Creates an operation that stores null results as nulls of returnType; null values reach applyImpl only if applyToNulls is true (otherwise they are just retyped).
- SingleValueOperation
  
  public SingleValueOperation(String name, FieldType returnType)
  
  Creates an operation that skips null values, only retyping them as nulls of returnType.
Method Details
- addExceptionProperties
  
  public DataException addExceptionProperties(DataException exception)
  
  Description copied from class: BasicFieldTransformer.Operation
  
  Adds this operation's details to an exception raised while it runs; returns the same exception.
  
  Overrides:
  
  addExceptionProperties in class BasicFieldTransformer.Operation
- apply
  
  protected final void apply(Field field) throws Throwable
  
  Description copied from class: BasicFieldTransformer.Operation
  
  Applies this operation to the field, updating its value in place.
  
  Specified by:
  
  apply in class BasicFieldTransformer.Operation
  
  Throws:
  
  Throwable
- applyToNullArray
  
  protected void applyToNullArray(ArrayValue array)
- applyToFieldValue
  
  protected void applyToFieldValue(Field field, SingleValue input) throws Throwable
  
  Applies applyImpl to a field's single value and stores the result in the field.
  
  Throws:
  
  Throwable
- applyToArrayValue
  
  protected void applyToArrayValue(ArrayValue array, int index, SingleValue input) throws Throwable
  
  Applies applyImpl to the array element at the 0-based index and stores the result in the array.
  
  Throws:
  
  Throwable
- applyImpl
  
  protected abstract Object applyImpl(SingleValue input) throws Throwable
  
  Returns the replacement for input; return input itself to leave it unchanged or null to store a null of returnType.
  
  Throws:
  
  Throwable
- startArray
  
  public final void startArray(ArrayValue array) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called before the array's elements are visited.
  
  Specified by:
  
  startArray in interface INodeVisitor
  
  Throws:
  
  Throwable
- endArray
  
  public final void endArray(ArrayValue array) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called after all of the array's elements have been visited.
  
  Specified by:
  
  endArray in interface INodeVisitor
  
  Throws:
  
  Throwable
- startFieldValue
  
  public final void startFieldValue(Field field, ValueNode<?> value) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called before the field's value node is visited.
  
  Specified by:
  
  startFieldValue in interface INodeVisitor
  
  Throws:
  
  Throwable
- endFieldValue
  
  public final void endFieldValue(Field field, ValueNode<?> value) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called after the field's value node has been visited.
  
  Specified by:
  
  endFieldValue in interface INodeVisitor
  
  Throws:
  
  Throwable
- startArrayValue
  
  public final void startArrayValue(ArrayValue array, int index, ValueNode<?> value) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called before the element at the given 0-based index is visited.
  
  Specified by:
  
  startArrayValue in interface INodeVisitor
  
  Throws:
  
  Throwable
- endArrayValue
  
  public final void endArrayValue(ArrayValue array, int index, ValueNode<?> value) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called after the element at the given 0-based index has been visited.
  
  Specified by:
  
  endArrayValue in interface INodeVisitor
  
  Throws:
  
  Throwable
- startRecord
  
  public final void startRecord(Record record) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called before the record's fields are visited.
  
  Specified by:
  
  startRecord in interface INodeVisitor
  
  Throws:
  
  Throwable
- endRecord
  
  public final void endRecord(Record record) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called after all of the record's fields have been visited.
  
  Specified by:
  
  endRecord in interface INodeVisitor
  
  Throws:
  
  Throwable
- startField
  
  public final void startField(Field field) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called when a field is reached, before INodeVisitor.startFieldValue(Field, ValueNode).
  
  Specified by:
  
  startField in interface INodeVisitor
  
  Throws:
  
  Throwable
- endField
  
  public final void endField(Field field) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called last for a field, after INodeVisitor.endFieldValue(Field, ValueNode).
  
  Specified by:
  
  endField in interface INodeVisitor
  
  Throws:
  
  Throwable
- singleValue
  
  public final void singleValue(SingleValue value) throws Throwable
  
  Description copied from interface: INodeVisitor
  
  Called for each single (leaf) value; it has no matching end callback.
  
  Specified by:
  
  singleValue in interface INodeVisitor
  
  Throws:
  
  Throwable

Class BasicFieldTransformer.SingleValueOperation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.transform.BasicFieldTransformer.Operation

Methods inherited from class java.lang.Object

Field Details

returnType

applyToNulls

Constructor Details

SingleValueOperation

SingleValueOperation

Method Details

addExceptionProperties

apply

applyToNullArray

applyToFieldValue

applyToArrayValue

applyImpl

startArray

endArray

startFieldValue

endFieldValue

startArrayValue

endArrayValue

startRecord

endRecord

startField

endField

singleValue