Package tech.tablesaw.aggregate

Class StringFunction

java.lang.Object

tech.tablesaw.aggregate.AggregateFunction<StringColumn,String>

tech.tablesaw.aggregate.StringFunction

public abstract class StringFunction
extends AggregateFunction<StringColumn,String>

A partial implementation of aggregate functions to summarize over a StringColumn TODO: Consider renaming to StringAggregateFunction for consistency

Constructor Summary

Constructors

Constructor	Description
StringFunction(String name)	Constructs an StringFunction with the given name.

Method Summary

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

Methods inherited from class tech.tablesaw.aggregate.AggregateFunction

functionName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringFunction

public StringFunction(String name)

Constructs an StringFunction with the given name. The name may be used to name a column in the output when this function is used by Summarizer

Method Detail

summarize

public abstract String summarize(StringColumn column)

Description copied from class: AggregateFunction

Apply this function to the column argument

Specified by:

summarize in class AggregateFunction<StringColumn,String>

isCompatibleColumn

public boolean isCompatibleColumn(ColumnType type)

Returns true if the given ColumnType is compatible with this function

Specified by:

isCompatibleColumn in class AggregateFunction<StringColumn,String>

returnType

public ColumnType returnType()

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

Specified by:

returnType in class AggregateFunction<StringColumn,String>