Module is.codion.common.model

Package is.codion.common.model.table

Interface ColumnSummaryModel

public interface ColumnSummaryModel

A interface defining a class for providing summaries of numerical table columns: sum, average, minimum, maximum and minimum & maximum.
For instances use the columnSummaryModel(SummaryValueProvider) factory method.

See Also:

• columnSummaryModel(SummaryValueProvider)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ColumnSummaryModel.Summary	Specifies a summary provider
static interface	ColumnSummaryModel.SummaryValueProvider<T extends Number>	Provides the values on which to base the summary .
static interface	ColumnSummaryModel.SummaryValues<T extends Number>	The values to base a summary on.

Method Summary

Modifier and Type	Method	Description
static <T extends Number> ColumnSummaryModel	columnSummaryModel(ColumnSummaryModel.SummaryValueProvider<T> valueProvider)	Instantiates a new ColumnSummaryModel
State	locked()
List<ColumnSummaryModel.Summary>	summaries()
Value<ColumnSummaryModel.Summary>	summary()
ValueObserver<String>	summaryText()
static <T extends Number> ColumnSummaryModel.SummaryValues<T>	summaryValues(Collection<T> values, boolean subset)	Instantiates a new ColumnSummaryModel.SummaryValues.

Method Details

locked

State locked()

Returns:

the locked state, if true then changing summary type is disabled

summaries

List<ColumnSummaryModel.Summary> summaries()

Returns:

a list containing the available summaries

summary

Value<ColumnSummaryModel.Summary> summary()

Returns:

the value controlling the summary

summaryText

ValueObserver<String> summaryText()

Returns:

an observer for the string representing the summary value

columnSummaryModel

static <T extends Number> ColumnSummaryModel columnSummaryModel(ColumnSummaryModel.SummaryValueProvider<T> valueProvider)

Instantiates a new ColumnSummaryModel

Type Parameters:

T - the value type

Parameters:

valueProvider - the value provider

Returns:

a new ColumnSummaryModel instance

summaryValues

static <T extends Number>
ColumnSummaryModel.SummaryValues<T> summaryValues(Collection<T> values,
 boolean subset)

Instantiates a new ColumnSummaryModel.SummaryValues.

Type Parameters:

T - the value type

Parameters:

values - the values

subset - true if the values are a subset of the available values

Returns:

a new ColumnSummaryModel.SummaryValues instance.