org.datavec.api.transform.condition

Class BooleanCondition

java.lang.Object

org.datavec.api.transform.condition.BooleanCondition

All Implemented Interfaces:

Serializable, ColumnOp, Condition

public class BooleanCondition
extends Object
implements Condition

BooleanCondition: used for creating compound conditions, such as AND(ConditionA, ConditionB, ...)
As a BooleanCondition is a condition, these can be chained together, like NOT(OR(AND(...),AND(...)))

Author:

Alex Black

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BooleanCondition.Type

Constructor Summary

Constructors

Constructor and Description
BooleanCondition(BooleanCondition.Type type, Condition... conditions)

Method Summary

Modifier and Type	Method and Description
static Condition	AND(Condition... conditions) And of all the given conditions
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	condition(Object input) Condition on arbitrary input
boolean	conditionSequence(List<List<Writable>> sequence) Is the condition satisfied for the current input/sequence? Returns true if condition is satisfied, or false otherwise.
boolean	conditionSequence(Object sequence) Condition on arbitrary input
Schema	getInputSchema() Getter for the input schema
static Condition	NOT(Condition condition) Not of the given condition
static Condition	OR(Condition... conditions) Or of all the given conditions
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
String	toString()
Schema	transform(Schema inputSchema) Get the output schema for this transformation, given an input schema
static Condition	XOR(Condition first, Condition second) And of all the given conditions

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanCondition

public BooleanCondition(BooleanCondition.Type type,
                        Condition... conditions)

Method Detail

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:

condition

public 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

condition

public boolean condition(Object input)

Condition on arbitrary input

Specified by:

condition in interface Condition

Parameters:

input - the input to return the condition for

Returns:

true if the condition is met false otherwise

conditionSequence

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

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:

sequence - Current sequence

Returns:

true if condition satisfied, false otherwise

conditionSequence

public boolean conditionSequence(Object sequence)

Condition on arbitrary input

Specified by:

conditionSequence in interface Condition

Parameters:

sequence - the sequence to do a condition on

Returns:

true if the condition for the sequence is met false otherwise

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: Condition

Setter for the input schema

Specified by:

setInputSchema in interface ColumnOp

Specified by:

setInputSchema in interface Condition

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 Condition

Returns:

toString

public String toString()

Overrides:

toString in class Object

AND

public static Condition AND(Condition... conditions)

And of all the given conditions

Parameters:

conditions - the conditions to and

Returns:

a joint and of all these conditions

OR

public static Condition OR(Condition... conditions)

Or of all the given conditions

Parameters:

conditions - the conditions to or

Returns:

a joint and of all these conditions

NOT

public static Condition NOT(Condition condition)

Not of the given condition

Parameters:

condition - the conditions to and

Returns:

a joint and of all these condition

XOR

public static Condition XOR(Condition first,
                            Condition second)

And of all the given conditions

Parameters:

first - the first condition

second - the second condition for xor

Returns:

the xor of these 2 conditions