org.datavec.api.transform.condition.column

Interface ColumnCondition

All Superinterfaces:

ColumnOp, Condition, Operation<Schema,Schema>, Serializable

All Known Implementing Classes:

BaseColumnCondition, BooleanColumnCondition, CategoricalColumnCondition, DoubleColumnCondition, FloatColumnCondition, InfiniteColumnCondition, IntegerColumnCondition, InvalidValueColumnCondition, LongColumnCondition, NaNColumnCondition, NullWritableColumnCondition, StringColumnCondition, StringRegexColumnCondition, TimeColumnCondition, TrivialColumnCondition

public interface ColumnCondition
extends Condition, ColumnOp

Field Summary

Fields

Modifier and Type	Field and Description
static SequenceConditionMode	DEFAULT_SEQUENCE_CONDITION_MODE

Method Summary

Modifier and Type	Method and Description
boolean	columnCondition(Writable writable) Returns whether the given element meets the condition set by this operation
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
boolean	condition(List<Writable> list) Is the condition satisfied for the current input/example? Returns true if condition is satisfied, or false otherwise.
boolean	conditionSequence(List<List<Writable>> list) Is the condition satisfied for the current input/sequence? Returns true if condition is satisfied, or false otherwise.
boolean	conditionSequence(Object list) Condition on arbitrary input
Schema	getInputSchema() Getter for the 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
void	setInputSchema(Schema schema) Setter for the input schema
Schema	transform(Schema inputSchema) Get the output schema for this transformation, given an input schema

Methods inherited from interface org.datavec.api.transform.condition.Condition

condition

Field Detail

DEFAULT_SEQUENCE_CONDITION_MODE

static final SequenceConditionMode DEFAULT_SEQUENCE_CONDITION_MODE

Method Detail

setInputSchema

void setInputSchema(Schema schema)

Description copied from interface: Condition

Setter for the input schema

Specified by:

setInputSchema in interface ColumnOp

Specified by:

setInputSchema in interface Condition

transform

Schema transform(Schema inputSchema)

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

Specified by:

transform in interface Operation<Schema,Schema>

Parameters:

inputSchema -

getInputSchema

Schema getInputSchema()

Description copied from interface: Condition

Getter for the input schema

Specified by:

getInputSchema in interface ColumnOp

Specified by:

getInputSchema in interface Condition

Returns:

condition

boolean condition(List<Writable> list)

Description copied from interface: Condition

Is the condition satisfied for the current input/example?
Returns true if condition is satisfied, or false otherwise.

Specified by:

condition in interface Condition

Parameters:

list - Current example

Returns:

true if condition satisfied, false otherwise

conditionSequence

boolean conditionSequence(List<List<Writable>> list)

Description copied from interface: Condition

Is the condition satisfied for the current input/sequence?
Returns true if condition is satisfied, or false otherwise.

Specified by:

conditionSequence in interface Condition

Parameters:

list - Current sequence

Returns:

true if condition satisfied, false otherwise

conditionSequence

boolean conditionSequence(Object list)

Description copied from interface: Condition

Condition on arbitrary input

Specified by:

conditionSequence in interface Condition

Parameters:

list - the sequence to do a condition on

Returns:

true if the condition for the sequence is met false otherwise

outputColumnName

String outputColumnName()

The output column name after the operation has been applied

Specified by:

outputColumnName in interface ColumnOp

Returns:

the output column name

outputColumnNames

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

String[] columnNames()

Returns column names this op is meant to run on

Specified by:

columnNames in interface ColumnOp

Returns:

columnName

String columnName()

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

Specified by:

columnName in interface ColumnOp

Returns:

columnCondition

boolean columnCondition(Writable writable)

Returns whether the given element meets the condition set by this operation

Parameters:

writable - the element to test

Returns:

true if the condition is met false otherwise