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(SummaryValues) factory method.
See Also:

  • Method Details

    • locked

      is.codion.common.state.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

      is.codion.common.value.Value<ColumnSummaryModel.Summary> summary()
      Returns:
      the value controlling the summary

    • summaryText

      is.codion.common.value.ValueObserver<String> summaryText()
      Returns:
      an observer for the string representing the summary value

    • columnSummaryModel

      static <T extends Number> ColumnSummaryModel columnSummaryModel(ColumnSummaryModel.SummaryValues<T> summaryValues)
      Instantiates a new ColumnSummaryModel
      Type Parameters:
      T - the value type
      Parameters:
      summaryValues - the summary values
      Returns:
      a new ColumnSummaryModel instance