jetbrains.buildServer.serverSide.statistics.build
Class BuildValueTypeBase

java.lang.Object
  jetbrains.buildServer.serverSide.statistics.build.StorageValueProvider
      jetbrains.buildServer.serverSide.statistics.build.BuildValueTypeBase

All Implemented Interfaces:

ValueProvider, ValueType

Direct Known Subclasses:

BuildFinishAwareValueTypeBase

public abstract class BuildValueTypeBase
extends StorageValueProvider
implements ValueType

Base type for BuildValueTypes uses template

Field Summary

protected SBuildServer

myServer

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

myStorage

Constructor Summary

BuildValueTypeBase(SBuildServer server, BuildDataStorage storage, ValueProviderRegistry valueProviderRegistry, java.lang.String key)

BuildValueTypeBase(SBuildServer server, BuildDataStorage storage, ValueProviderRegistry valueProviderRegistry, java.lang.String key, java.text.Format format)

Method Summary

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() Returns value format
protected boolean	hasAtLeastOneBuild(java.lang.String buildTypeId)
boolean	hasData(ChartSettings buildChartSettings) Returns true if at least one not-null value is available for this ValueProvider for given settings
protected boolean	isAvailable(java.lang.String buildTypeId)

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.ValueType

getDescription

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

getDataSet, getKey

Field Detail

myServer

protected final SBuildServer myServer

Constructor Detail

BuildValueTypeBase

public BuildValueTypeBase(SBuildServer server,
                          BuildDataStorage storage,
                          ValueProviderRegistry valueProviderRegistry,
                          java.lang.String key)

BuildValueTypeBase

public BuildValueTypeBase(SBuildServer server,
                          BuildDataStorage storage,
                          ValueProviderRegistry valueProviderRegistry,
                          java.lang.String key,
                          java.text.Format format)

Method Detail

isAvailable

protected boolean isAvailable(java.lang.String buildTypeId)

hasData

public boolean hasData(ChartSettings buildChartSettings)

Description copied from interface: ValueProvider

Returns true if at least one not-null value is available for this ValueProvider for given settings

Specified by:

hasData in interface ValueProvider

Overrides:

hasData in class StorageValueProvider

Parameters:

buildChartSettings - dataset chartSettings

Returns:

true if there are some data available for this ValueProvider with given settings

getValueFormat

@Nullable
public java.text.Format getValueFormat()

Returns value format

Specified by:

getValueFormat in interface ValueType

Returns:

see above

getExtendedDescription

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

Description copied from interface: ValueType

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

Specified by:

getExtendedDescription in interface ValueType

Parameters:

chartSettings - curent filter may be useful to generate string

Returns:

getDescription(chartSettings) by default

getSeriesColor

public java.awt.Color getSeriesColor(java.lang.String s)

Description copied from interface: ValueType

Allows to provide special color coding for series

Specified by:

getSeriesColor in interface ValueType

Parameters:

s - series key

Returns:

series color, null to autogenerate by renderer

getSeriesGenericName

public java.lang.String getSeriesGenericName()

Description copied from interface: ValueType

Generic name for this value's series

Specified by:

getSeriesGenericName in interface ValueType

Returns:

short name string

hasAtLeastOneBuild

protected final boolean hasAtLeastOneBuild(java.lang.String buildTypeId)