org.datavec.api.transform.condition.column

Class BaseColumnCondition

java.lang.Object

org.datavec.api.transform.condition.column.BaseColumnCondition

All Implemented Interfaces:

java.io.Serializable, ColumnOp, ColumnCondition, Condition

Direct Known Subclasses:

BooleanColumnCondition, CategoricalColumnCondition, DoubleColumnCondition, IntegerColumnCondition, InvalidValueColumnCondition, LongColumnCondition, NullWritableColumnCondition, StringColumnCondition, StringRegexColumnCondition, TimeColumnCondition

public abstract class BaseColumnCondition
extends java.lang.Object
implements ColumnCondition

Abstract class for column conditions

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	columnIdx
protected java.lang.String	columnName
protected Schema	schema
protected SequenceConditionMode	sequenceMode

Fields inherited from interface org.datavec.api.transform.condition.column.ColumnCondition

DEFAULT_SEQUENCE_CONDITION_MODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseColumnCondition(java.lang.String columnName, SequenceConditionMode sequenceConditionMode)

Method Summary

Modifier and Type	Method and Description
java.lang.String	columnName() Returns a singular column name this op is meant to run on
java.lang.String[]	columnNames() Returns column names this op is meant to run on
boolean	condition(java.util.List<Writable> list) Is the condition satisfied for the current input/example? Returns true if condition is satisfied, or false otherwise.
boolean	conditionSequence(java.util.List<java.util.List<Writable>> list) Is the condition satisfied for the current input/sequence? Returns true if condition is satisfied, or false otherwise.
boolean	conditionSequence(java.lang.Object list) Condition on arbitrary input
Schema	getInputSchema() Getter for the input schema
java.lang.String	outputColumnName() The output column name after the operation has been applied
java.lang.String[]	outputColumnNames() The output column names This will often be the same as the input
void	setInputSchema(Schema schema) Setter for the input schema
abstract java.lang.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

Methods inherited from interface org.datavec.api.transform.condition.column.ColumnCondition

columnCondition

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

condition

Field Detail

columnName

protected final java.lang.String columnName

columnIdx

protected int columnIdx

schema

protected Schema schema

sequenceMode

protected SequenceConditionMode sequenceMode

Constructor Detail

BaseColumnCondition

protected BaseColumnCondition(java.lang.String columnName,
                              SequenceConditionMode sequenceConditionMode)

Method Detail

setInputSchema

public 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 ColumnCondition

Specified by:

setInputSchema in interface Condition

transform

public Schema transform(Schema inputSchema)

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

Specified by:

transform in interface ColumnOp

Specified by:

transform in interface ColumnCondition

Parameters:

inputSchema -

getInputSchema

public Schema getInputSchema()

Description copied from interface: Condition

Getter for the input schema

Specified by:

getInputSchema in interface ColumnOp

Specified by:

getInputSchema in interface ColumnCondition

Specified by:

getInputSchema in interface Condition

Returns:

condition

public boolean condition(java.util.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 ColumnCondition

Specified by:

condition in interface Condition

Parameters:

list - Current example

Returns:

true if condition satisfied, false otherwise

conditionSequence

public boolean conditionSequence(java.util.List<java.util.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 ColumnCondition

Specified by:

conditionSequence in interface Condition

Parameters:

list - Current sequence

Returns:

true if condition satisfied, false otherwise

conditionSequence

public boolean conditionSequence(java.lang.Object list)

Description copied from interface: Condition

Condition on arbitrary input

Specified by:

conditionSequence in interface ColumnCondition

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

public java.lang.String outputColumnName()

The output column name after the operation has been applied

Specified by:

outputColumnName in interface ColumnOp

Specified by:

outputColumnName in interface ColumnCondition

Returns:

the output column name

outputColumnNames

public java.lang.String[] outputColumnNames()

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

Specified by:

outputColumnNames in interface ColumnOp

Specified by:

outputColumnNames in interface ColumnCondition

Returns:

the output column names

columnNames

public java.lang.String[] columnNames()

Returns column names this op is meant to run on

Specified by:

columnNames in interface ColumnOp

Specified by:

columnNames in interface ColumnCondition

Returns:

columnName

public java.lang.String columnName()

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

Specified by:

columnName in interface ColumnOp

Specified by:

columnName in interface ColumnCondition

Returns:

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object