com.atlassian.clover.reporters

Interface ColumnFormat

All Known Implementing Classes:

ColumnFormat.BarGraphColumnFormat, ColumnFormat.ErrorColumnFormat, ColumnFormat.FloatColumnFormat, ColumnFormat.IntColumnFormat, ColumnFormat.LongBarGraphColumnFormat, ColumnFormat.PercentageColumnFormat, ColumnFormat.ShortBarGraphColumnFormat

public interface ColumnFormat

A class used to render values and titles of specific columns.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ColumnFormat.BarGraphColumnFormat
static class	ColumnFormat.ErrorColumnFormat A formatter to use when there is no data and an error message should be displayed instead.
static class	ColumnFormat.Factory
static class	ColumnFormat.FloatColumnFormat
static class	ColumnFormat.IntColumnFormat
static class	ColumnFormat.LongBarGraphColumnFormat
static class	ColumnFormat.PercentageColumnFormat
static class	ColumnFormat.ShortBarGraphColumnFormat

Field Summary

Fields

Modifier and Type	Field and Description
static String	BAR
static String	LONGBAR
static String	PC
static String	PERCENTAGE
static String	RAW
static String	SHORTBAR
static String	SORT_TYPE_ALPHA
static String	SORT_TYPE_NUMBER

Method Summary

Modifier and Type	Method and Description
String	format(Column.ColumnData data)
Number	formatNumber(Column.ColumnData data)
String	formatTitle(String name)
int	getColSpan()
boolean	isWithinThreshold(Column.ColumnData data, float min, float max)
String	sortType() Returns the type of sorting required for sort value.
String	sortValue(Column.ColumnData data) Formats the value to sort by.

Field Detail

PERCENTAGE

static final String PERCENTAGE

See Also:

Constant Field Values

PC

static final String PC

See Also:

Constant Field Values

RAW

static final String RAW

See Also:

Constant Field Values

BAR

static final String BAR

See Also:

Constant Field Values

LONGBAR

static final String LONGBAR

See Also:

Constant Field Values

SHORTBAR

static final String SHORTBAR

See Also:

Constant Field Values

SORT_TYPE_NUMBER

static final String SORT_TYPE_NUMBER

See Also:

Constant Field Values

SORT_TYPE_ALPHA

static final String SORT_TYPE_ALPHA

See Also:

Constant Field Values

Method Detail

format

String format(Column.ColumnData data)

formatNumber

Number formatNumber(Column.ColumnData data)

formatTitle

String formatTitle(String name)

sortValue

String sortValue(Column.ColumnData data)

Formats the value to sort by.

Returns:

the value to sort by.

sortType

String sortType()

Returns the type of sorting required for sort value.

Returns:

the sort type, one of SORT_TYPE_ALPHA or SORT_TYPE_NUMBER

getColSpan

int getColSpan()

isWithinThreshold

boolean isWithinThreshold(Column.ColumnData data,
                          float min,
                          float max)