org.datavec.api.transform.sequence.comparator

Class BaseColumnComparator

java.lang.Object

org.datavec.api.transform.sequence.comparator.BaseColumnComparator

All Implemented Interfaces:

java.io.Serializable, java.util.Comparator<java.util.List<Writable>>, ColumnOp, SequenceComparator

Direct Known Subclasses:

NumericalColumnComparator, StringComparator

public abstract class BaseColumnComparator
extends java.lang.Object
implements SequenceComparator, ColumnOp

Compare/sort a sequence by the values of a specific column

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseColumnComparator(java.lang.String columnName)

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
int	compare(java.util.List<Writable> o1, java.util.List<Writable> o2)
protected abstract int	compare(Writable w1, Writable w2)
Schema	getInputSchema() Getter for 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 inputSchema) Set the input schema.
void	setSchema(Schema sequenceSchema)
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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

schema

protected Schema schema

columnName

protected final java.lang.String columnName

columnIdx

protected int columnIdx

Constructor Detail

BaseColumnComparator

protected BaseColumnComparator(java.lang.String columnName)

Method Detail

setSchema

public void setSchema(Schema sequenceSchema)

Specified by:

setSchema in interface SequenceComparator

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 inputSchema)

Set the input schema.

Specified by:

setInputSchema in interface ColumnOp

Parameters:

inputSchema -

getInputSchema

public Schema getInputSchema()

Getter for input schema

Specified by:

getInputSchema in interface ColumnOp

Returns:

compare

public int compare(java.util.List<Writable> o1,
                   java.util.List<Writable> o2)

Specified by:

compare in interface java.util.Comparator<java.util.List<Writable>>

compare

protected abstract int compare(Writable w1,
                               Writable w2)

outputColumnName

public java.lang.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 java.lang.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 java.lang.String[] columnNames()

Returns column names this op is meant to run on

Specified by:

columnNames in interface ColumnOp

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

Returns: