org.jminor.common.model.table

Interface ColumnSummaryModel

All Known Implementing Classes:

DefaultColumnSummaryModel

public interface ColumnSummaryModel

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ColumnSummaryModel.ColumnValueProvider Provides the values used when creating the summary value.
static interface	ColumnSummaryModel.Summary Specifies a summary provider

Method Summary

Modifier and Type	Method and Description
void	addSummaryListener(EventDataListener<ColumnSummaryModel.Summary> listener)
void	addSummaryValueListener(EventListener listener)
java.util.List<ColumnSummaryModel.Summary>	getAvailableSummaries()
ColumnSummaryModel.Summary	getSummary()
java.lang.String	getSummaryText()
boolean	isLocked()
void	removeSummaryListener(EventDataListener<ColumnSummaryModel.Summary> listener)
void	removeSummaryValueListener(EventListener listener)
void	setLocked(boolean value)
void	setSummary(ColumnSummaryModel.Summary summary)

Method Detail

setSummary

void setSummary(ColumnSummaryModel.Summary summary)

Parameters:

summary - the type of summary to show

getSummary

ColumnSummaryModel.Summary getSummary()

Returns:

the current summary type

isLocked

boolean isLocked()

Returns:

true if changing the summary type is disabled

setLocked

void setLocked(boolean value)

Parameters:

value - if true then changing summary type is disable

getAvailableSummaries

java.util.List<ColumnSummaryModel.Summary> getAvailableSummaries()

Returns:

a list containing the available summaries

getSummaryText

java.lang.String getSummaryText()

Returns:

a string representing the summary value

addSummaryValueListener

void addSummaryValueListener(EventListener listener)

Parameters:

listener - a listener to be notified each time the summary value changes

removeSummaryValueListener

void removeSummaryValueListener(EventListener listener)

Parameters:

listener - the listener to remove

addSummaryListener

void addSummaryListener(EventDataListener<ColumnSummaryModel.Summary> listener)

Parameters:

listener - a listener to be notified each time the summary type changes

removeSummaryListener

void removeSummaryListener(EventDataListener<ColumnSummaryModel.Summary> listener)

Parameters:

listener - the listener to remove