org.datavec.api.transform.condition.column

Class CategoricalColumnCondition

java.lang.Object

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

org.datavec.api.transform.condition.column.CategoricalColumnCondition

All Implemented Interfaces:

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

public class CategoricalColumnCondition
extends BaseColumnCondition

Condition that applies to the values in a Categorical column, using a ConditionOp

Author:

Alex Black

See Also:

Serialized Form

Field Summary

Fields inherited from class org.datavec.api.transform.condition.column.BaseColumnCondition

columnIdx, columnName, schema, sequenceMode

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

DEFAULT_SEQUENCE_CONDITION_MODE

Constructor Summary

Constructors

Constructor and Description
CategoricalColumnCondition(String columnName, ConditionOp op, Set<String> set) Constructor for operations: ConditionOp.InSet, ConditionOp.NotInSet Uses default sequence condition mode, ColumnCondition.DEFAULT_SEQUENCE_CONDITION_MODE
CategoricalColumnCondition(String columnName, ConditionOp op, String value) Constructor for conditions equal or not equal.
CategoricalColumnCondition(String columnName, SequenceConditionMode sequenceConditionMode, ConditionOp op, Set<String> set) Constructor for operations: ConditionOp.InSet, ConditionOp.NotInSet
CategoricalColumnCondition(String columnName, SequenceConditionMode sequenceConditionMode, ConditionOp op, String value) Constructor for conditions equal or not equal

Method Summary

Modifier and Type	Method and Description
boolean	columnCondition(Writable writable) Returns whether the given element meets the condition set by this operation
boolean	condition(Object input) Condition on arbitrary input
String	toString()

Methods inherited from class org.datavec.api.transform.condition.column.BaseColumnCondition

columnName, columnNames, condition, conditionSequence, conditionSequence, getInputSchema, outputColumnName, outputColumnNames, setInputSchema, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoricalColumnCondition

public CategoricalColumnCondition(String columnName,
                                  ConditionOp op,
                                  String value)

Constructor for conditions equal or not equal. Uses default sequence condition mode, ColumnCondition.DEFAULT_SEQUENCE_CONDITION_MODE

Parameters:

columnName - Column to check for the condition

op - Operation (== or != only)

value - Value to use in the condition

CategoricalColumnCondition

public CategoricalColumnCondition(String columnName,
                                  SequenceConditionMode sequenceConditionMode,
                                  ConditionOp op,
                                  String value)

Constructor for conditions equal or not equal

Parameters:

columnName - Column to check for the condition

sequenceConditionMode - Mode for handling sequence data

op - Operation (== or != only)

value - Value to use in the condition

CategoricalColumnCondition

public CategoricalColumnCondition(String columnName,
                                  ConditionOp op,
                                  Set<String> set)

Constructor for operations: ConditionOp.InSet, ConditionOp.NotInSet Uses default sequence condition mode, ColumnCondition.DEFAULT_SEQUENCE_CONDITION_MODE

Parameters:

columnName - Column to check for the condition

op - Operation. Must be either ConditionOp.InSet, ConditionOp.NotInSet

set - Set to use in the condition

CategoricalColumnCondition

public CategoricalColumnCondition(String columnName,
                                  SequenceConditionMode sequenceConditionMode,
                                  ConditionOp op,
                                  Set<String> set)

Constructor for operations: ConditionOp.InSet, ConditionOp.NotInSet

Parameters:

columnName - Column to check for the condition

sequenceConditionMode - Mode for handling sequence data

op - Operation. Must be either ConditionOp.InSet, ConditionOp.NotInSet

set - Set to use in the condition

Method Detail

columnCondition

public boolean columnCondition(Writable writable)

Description copied from interface: ColumnCondition

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

toString

public String toString()

Specified by:

toString in class BaseColumnCondition

condition

public boolean condition(Object input)

Condition on arbitrary input

Parameters:

input - the input to return the condition for

Returns:

true if the condition is met false otherwise