org.datavec.api.transform.transform.condition

Class ConditionalCopyValueTransform

java.lang.Object

org.datavec.api.transform.transform.condition.ConditionalCopyValueTransform

All Implemented Interfaces:

Serializable, ColumnOp, Transform

public class ConditionalCopyValueTransform
extends Object
implements Transform, ColumnOp

Replace the value in a specified column with a new value taken from another column, if a condition is satisfied/true.
Note that the condition can be any generic condition, including on other column(s), different to the column that will be modified if the condition is satisfied/true.

Note: For sequences, this transform use the convention that each step in the sequence is passed to the condition, and replaced (or not) separately (i.e., Condition.condition(List) is used on each time step individually)

Author:

Alex Black

See Also:

to do a conditional replacement with a fixed value (instead of a value from another column), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConditionalCopyValueTransform(String columnToReplace, String sourceColumn, Condition condition)

Method Summary

Modifier and Type	Method and Description
String	columnName() Returns a singular column name this op is meant to run on
String[]	columnNames() Returns column names this op is meant to run on
Schema	getInputSchema() Getter for input schema
List<Writable>	map(List<Writable> writables) Transform a writable in to another writable
Object	map(Object input) Transform an object in to another object
List<List<Writable>>	mapSequence(List<List<Writable>> sequence) Transform a sequence
Object	mapSequence(Object sequence) Transform a sequence
String	outputColumnName() The output column name after the operation has been applied
String[]	outputColumnNames() The output column names This will often be the same as the input
void	setInputSchema(Schema inputSchema) Set the input schema.
String	toString()
Schema	transform(Schema inputSchema) Get the output schema for this transformation, given an input schema

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionalCopyValueTransform

public ConditionalCopyValueTransform(String columnToReplace,
                                     String sourceColumn,
                                     Condition condition)

Parameters:

columnToReplace - Name of the column in which to replace the old value

sourceColumn - Name of the column to get the new value from

condition - Condition

Method Detail

transform

public Schema transform(Schema inputSchema)

Description copied from interface: ColumnOp

Get the output schema for this transformation, given an input schema

Specified by:

transform in interface ColumnOp

setInputSchema

public void setInputSchema(Schema inputSchema)

Description copied from interface: ColumnOp

Set the input schema.

Specified by:

setInputSchema in interface ColumnOp

getInputSchema

public Schema getInputSchema()

Description copied from interface: ColumnOp

Getter for input schema

Specified by:

getInputSchema in interface ColumnOp

Returns:

map

public List<Writable> map(List<Writable> writables)

Description copied from interface: Transform

Transform a writable in to another writable

Specified by:

map in interface Transform

Parameters:

writables - the record to transform

Returns:

the transformed writable

mapSequence

public List<List<Writable>> mapSequence(List<List<Writable>> sequence)

Description copied from interface: Transform

Transform a sequence

Specified by:

mapSequence in interface Transform

map

public Object map(Object input)

Transform an object in to another object

Specified by:

map in interface Transform

Parameters:

input - the record to transform

Returns:

the transformed writable

mapSequence

public Object mapSequence(Object sequence)

Transform a sequence

Specified by:

mapSequence in interface Transform

Parameters:

sequence -

toString

public String toString()

Overrides:

toString in class Object

outputColumnName

public String outputColumnName()

The output column name after the operation has been applied

Specified by:

outputColumnName in interface ColumnOp

Returns:

the output column name

outputColumnNames

public String[] outputColumnNames()

The output column names This will often be the same as the input

Specified by:

outputColumnNames in interface ColumnOp

Returns:

the output column names

columnNames

public String[] columnNames()

Returns column names this op is meant to run on

Specified by:

columnNames in interface ColumnOp

Returns:

columnName

public String columnName()

Returns a singular column name this op is meant to run on

Specified by:

columnName in interface ColumnOp

Returns: