jetbrains.buildServer.serverSide.statistics
Interface ValueType

All Superinterfaces:

ValueProvider

All Known Implementing Classes:

BuildFinishAwareValueTypeBase, BuildValueTypeBase, CompositeVTB, DeclarativeCompositeValueType

public interface ValueType
extends ValueProvider

Statistic value type - such value type can be shown as a separate graph in the UI.

Method Summary

java.lang.String	getDescription(ChartSettings chartSettings) Metric textual description, i.e.
java.lang.String	getExtendedDescription(ChartSettings chartSettings) Extended metric textual description (for tooltip), i.e.
java.awt.Color	getSeriesColor(java.lang.String s) Allows to provide special color coding for series
java.lang.String	getSeriesGenericName() Generic name for this value's series
java.text.Format	getValueFormat() Format for Values (point hints and axis).

Methods inherited from interface jetbrains.buildServer.serverSide.statistics.ValueProvider

getDataSet, getKey, hasData

Method Detail

getDescription

@NotNull
java.lang.String getDescription(ChartSettings chartSettings)

Metric textual description, i.e. "Build Duration"

Parameters:

chartSettings - the same settings as passed to ValueProvider.getDataSet(ChartSettings) method

Returns:

graph description, used in graph title on the web

getExtendedDescription

@NotNull
java.lang.String getExtendedDescription(ChartSettings chartSettings)

Extended metric textual description (for tooltip), i.e. "Build Duration (includes stages A, B, C)"

Parameters:

chartSettings - the same filter as passed to ValueProvider.getDataSet(ChartSettings) method

Returns:

graph description, used in graph title on the web

getValueFormat

@Nullable
java.text.Format getValueFormat()

Format for Values (point hints and axis).

Returns:

either NumberFormat or DateFormat descendant (new instance) or null for default number format

getSeriesColor

@Nullable
java.awt.Color getSeriesColor(java.lang.String s)

Allows to provide special color coding for series

Parameters:

s - series key

Returns:

series color, null to autogenerate by renderer

getSeriesGenericName

java.lang.String getSeriesGenericName()

Generic name for this value's series

Returns:

short name string