Package tech.tablesaw.aggregate

Class AggregateFunction<INCOL extends Column<?>,OUT>

java.lang.Object

tech.tablesaw.aggregate.AggregateFunction<INCOL,OUT>

Direct Known Subclasses:

AnyIntAggregateFunction, BooleanAggregateFunction, BooleanDoubleAggregateFunction, BooleanIntAggregateFunction, DateAggregateFunction, DateTimeAggregateFunction, InstantAggregateFunction, NumericAggregateFunction, StringAggregateFunction, StringFunction, TimeAggregateFunction

public abstract class AggregateFunction<INCOL extends Column<?>,OUT>
extends Object

An abstract class that provides a partial implementation of aggregate functions to summarize over a column

Constructor Summary

Constructors

Constructor	Description
AggregateFunction(String functionName)	Constructs a function with the given name

Method Summary

Modifier and Type	Method	Description
String	functionName()	Returns this function's name
abstract boolean	isCompatibleColumn(ColumnType type)	Returns true if the given ColumnType is compatible with this function
abstract ColumnType	returnType()	Returns the ColumnType to be used for the values returned by this function
abstract OUT	summarize(INCOL column)	Apply this function to the column argument
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AggregateFunction

public AggregateFunction(String functionName)

Constructs a function with the given name

Method Details

functionName

public String functionName()

Returns this function's name

summarize

public abstract OUT summarize(INCOL column)

Apply this function to the column argument

toString

public String toString()

Overrides:

toString in class Object

isCompatibleColumn

public abstract boolean isCompatibleColumn(ColumnType type)

Returns true if the given ColumnType is compatible with this function

returnType

public abstract ColumnType returnType()

Returns the ColumnType to be used for the values returned by this function