SummaryModel

public interface SummaryModel

A interface defining a class for providing summaries of numerical table columns: sum, average, minimum, maximum and minimum & maximum.

For instances use the summaryModel(SummaryValues) factory method.

See Also:

summaryModel(SummaryValues)

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

SummaryModel.Summary

Specifies a summary provider

static interface

SummaryModel.SummaryValues<T extends Number>

Provides the values on which to base the summary .
Method Summary

Modifier and Type

Method

Description

State

locked()

List<SummaryModel.Summary>

summaries()

Value<SummaryModel.Summary>

summary()

static <T extends Number> SummaryModel

summaryModel(SummaryModel.SummaryValues<T> summaryValues)

Instantiates a new SummaryModel

ValueObserver<String>

summaryText()

Method Details
- locked
  
  State locked()
  
  Returns:
  
  the locked state, if true then changing summary type is disabled
- summaries
  
  List<SummaryModel.Summary> summaries()
  
  Returns:
  
  a list containing the available summaries
- summary
  
  Value<SummaryModel.Summary> summary()
  
  Returns:
  
  the Value controlling the summary
- summaryText
  
  ValueObserver<String> summaryText()
  
  Returns:
  
  an observer for the string representing the summary value
- summaryModel
  
  static <T extends Number> SummaryModel summaryModel(SummaryModel.SummaryValues<T> summaryValues)
  
  Instantiates a new SummaryModel
  
  Type Parameters:
  
  T - the value type
  
  Parameters:
  
  summaryValues - the summary values
  
  Returns:
  
  a new SummaryModel instance