org.datavec.api.transform.filter

Class FilterInvalidValues

java.lang.Object

org.datavec.api.transform.filter.FilterInvalidValues

All Implemented Interfaces:

Serializable, ColumnOp, Filter

public class FilterInvalidValues
extends Object
implements Filter

FilterInvalidValues: a filter operation that removes any examples (or sequences) if the examples/sequences contains invalid values in any of a specified set of columns. Invalid values are determined with respect to the schema

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilterInvalidValues() Filter examples that have invalid values in ANY columns.
FilterInvalidValues(String... columnsToFilterIfInvalid)

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
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
boolean	removeExample(List<Writable> writables)
boolean	removeExample(Object writables)
boolean	removeSequence(List<List<Writable>> sequence)
boolean	removeSequence(Object sequence)
void	setInputSchema(Schema schema) Set the input schema.
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, toString, wait, wait, wait

Constructor Detail

FilterInvalidValues

public FilterInvalidValues()

Filter examples that have invalid values in ANY columns.

FilterInvalidValues

public FilterInvalidValues(String... columnsToFilterIfInvalid)

Parameters:

columnsToFilterIfInvalid - Columns to check for invalid values

Method Detail

transform

public Schema transform(Schema inputSchema)

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

Specified by:

transform in interface ColumnOp

Parameters:

inputSchema -

setInputSchema

public void setInputSchema(Schema schema)

Description copied from interface: ColumnOp

Set the input schema.

Specified by:

setInputSchema in interface ColumnOp

Specified by:

setInputSchema in interface Filter

getInputSchema

public Schema getInputSchema()

Description copied from interface: ColumnOp

Getter for input schema

Specified by:

getInputSchema in interface ColumnOp

Specified by:

getInputSchema in interface Filter

Returns:

removeExample

public boolean removeExample(Object writables)

Specified by:

removeExample in interface Filter

Parameters:

writables - Example

Returns:

true if example should be removed, false to keep

removeSequence

public boolean removeSequence(Object sequence)

Specified by:

removeSequence in interface Filter

Parameters:

sequence - sequence example

Returns:

true if example should be removed, false to keep

removeExample

public boolean removeExample(List<Writable> writables)

Specified by:

removeExample in interface Filter

Parameters:

writables - Example

Returns:

true if example should be removed, false to keep

removeSequence

public boolean removeSequence(List<List<Writable>> sequence)

Specified by:

removeSequence in interface Filter

Parameters:

sequence - sequence example

Returns:

true if example should be removed, false to keep

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: