jetbrains.buildServer.serverSide.statistics
Interface ValueProvider

All Known Subinterfaces:
ValueType
All Known Implementing Classes:
BuildFinishAwareValueTypeBase, BuildValueTypeBase, CompositeVTB, DeclarativeCompositeValueType, StorageValueProvider

public interface ValueProvider

Represents a source of statistics data

Author:
kir
See Also:
ValueProviderRegistry

Method Summary
 java.util.List<BuildValue> getDataSet(ChartSettings chartSettings)
          This should return dataset based given chartSettings
 java.lang.String getKey()
          Metric id i.e.
 boolean hasData(ChartSettings chartSettings)
          Returns true if at least one not-null value is available for this ValueProvider for given settings
 

Method Detail

getKey

java.lang.String getKey()
Metric id i.e. "BuildDuration", this key should be unique

Returns:
Unique key name

getDataSet

@NotNull
java.util.List<BuildValue> getDataSet(@NotNull
                                              ChartSettings chartSettings)
This should return dataset based given chartSettings

Parameters:
chartSettings - to be applied to dataset
Returns:
filtered dataset

hasData

boolean hasData(ChartSettings chartSettings)
Returns true if at least one not-null value is available for this ValueProvider for given settings

Parameters:
chartSettings - dataset chartSettings
Returns:
true if there are some data available for this ValueProvider with given settings