Package jetbrains.buildServer.serverSide.statistics.build

Class SimpleBuildMetricVT

java.lang.Object

jetbrains.buildServer.serverSide.statistics.build.StorageValueProvider

jetbrains.buildServer.serverSide.statistics.build.BuildValueTypeBase

jetbrains.buildServer.serverSide.statistics.build.SimpleBuildMetricVT

All Implemented Interfaces:

BuildValueProvider, ValueProvider, ValueType

public class SimpleBuildMetricVT
extends BuildValueTypeBase

A simple Value Type to handle values published by service messages and directly through DataStorage interface.

User: Andrei Titov Date: 8/20/13

Field Summary

Fields inherited from class jetbrains.buildServer.serverSide.statistics.build.BuildValueTypeBase

myServer

Fields inherited from class jetbrains.buildServer.serverSide.statistics.build.StorageValueProvider

myStorage

Constructor Summary

Constructors

Constructor	Description
SimpleBuildMetricVT(SBuildServer server, BuildDataStorage storage, ValueProviderRegistry valueProviderRegistry, String key, String description)
SimpleBuildMetricVT(SBuildServer server, BuildDataStorage storage, ValueProviderRegistry valueProviderRegistry, String key, String description, String format)

Method Summary

Modifier and Type	Method	Description
BigDecimal	calculateBuildMetric(SBuild build)
Map<String,BuildValue>	getData(SBuild build)
String	getDescription(ChartSettings chartSettings)	Metric textual description, i.e.

Methods inherited from class jetbrains.buildServer.serverSide.statistics.build.BuildValueTypeBase

getExtendedDescription, getSeriesColor, getSeriesGenericName, getValueFormat, getValueFormat, hasData, isAvailable, transformToBuildValues

Methods inherited from class jetbrains.buildServer.serverSide.statistics.build.StorageValueProvider

getDataSet, getKey, getValueProcessor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDataSet, getKey

Constructor Detail

SimpleBuildMetricVT

public SimpleBuildMetricVT(SBuildServer server,
                           BuildDataStorage storage,
                           ValueProviderRegistry valueProviderRegistry,
                           String key,
                           String description)

SimpleBuildMetricVT

public SimpleBuildMetricVT(SBuildServer server,
                           BuildDataStorage storage,
                           ValueProviderRegistry valueProviderRegistry,
                           String key,
                           String description,
                           String format)

Method Detail

getDescription

@NotNull
public final String getDescription(@Nullable
                                   ChartSettings chartSettings)

Description copied from interface: ValueType

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

calculateBuildMetric

@Nullable
public BigDecimal calculateBuildMetric(@NotNull
                                       SBuild build)

getData

@NotNull
public Map<String,BuildValue> getData(@NotNull
                                            SBuild build)

Specified by:

getData in interface BuildValueProvider

Overrides:

getData in class BuildValueTypeBase

Parameters:

build - build to return statistics value for

Returns:

map of build values provided by this value provider for a given build (each value provider can report more than one statistics value, see CompositeVTB).