Package jetbrains.buildServer.web.statistics.graph

Class GraphBean

java.lang.Object

jetbrains.buildServer.web.statistics.graph.GraphBean

public class GraphBean
extends Object

Descriptor for a custom graph. Some details for the descriptor can be obtained from http://confluence.jetbrains.com/display/TCDL/Custom+Chart

Author:

kir

Constructor Summary

Constructors

Constructor	Description
GraphBean(String title, String defaultFilters, String hiddenFilters)
GraphBean(SProjectFeatureDescriptor descriptor, ProjectManager projectManager)
GraphBean(org.jdom.Element element)

Method Summary

Modifier and Type	Method	Description
jetbrains.buildServer.web.statistics.graph.GraphBean.ValueTypeBean	addValueType(String key, String description, String buildTypeId)	Adds nested value type bean, which describes another named series of data on the graph
jetbrains.buildServer.web.statistics.graph.GraphBean.ValueTypeBean	addValueType(String key, String description, String buildTypeId, String color)	Adds nested value type bean, which describes another named series of data on the graph
boolean	equals(Object o)
String	getDefaultFilters()
String	getFormat()
String	getGraphId()
String	getHiddenFilters()
Map<String,String>	getProperties()
String	getSerieTitle()
String	getTitle()
List<jetbrains.buildServer.web.statistics.graph.GraphBean.ValueTypeBean>	getValueTypes()
int	hashCode()
void	readFrom(org.jdom.Element element)
void	setDefaultFilters(String defaultFilters)	Set list of default filters (which checkboxes should be checked by default)
void	setFormat(String format)
void	setHiddenFilters(String hiddenFilters)	Set list of filters which should not be visible
void	setProperties(Map<String,String> properties)
void	setSerieTitle(String serieTitle)	Set title for series filter
void	setTitle(String title)	Set graph title
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GraphBean

public GraphBean(org.jdom.Element element)

GraphBean

public GraphBean(String title,
                 String defaultFilters,
                 String hiddenFilters)

Parameters:

title - title of the graph

defaultFilters - comma-separated list of filters (possible values are 'averaged', 'showFailed')

hiddenFilters - comma-separated list of filters (possible values are 'all', 'averaged', 'showFailed', 'range', 'series' )

GraphBean

public GraphBean(@NotNull
                 SProjectFeatureDescriptor descriptor,
                 @NotNull
                 ProjectManager projectManager)

Method Detail

getFormat

@Nullable
public String getFormat()

setFormat

public void setFormat(String format)

getGraphId

@NotNull
public String getGraphId()

Returns:

graph identifier

getTitle

@NotNull
public String getTitle()

Returns:

graph title

setTitle

public void setTitle(String title)

Set graph title

Parameters:

title - graph title

setSerieTitle

public void setSerieTitle(String serieTitle)

Set title for series filter

Parameters:

serieTitle - series filter title

getSerieTitle

@Nullable
public String getSerieTitle()

Returns:

series filter title

getDefaultFilters

@NotNull
public String getDefaultFilters()

Returns:

list of default filters (which checkboxes should be checked by default)

setDefaultFilters

public void setDefaultFilters(String defaultFilters)

Set list of default filters (which checkboxes should be checked by default)

Parameters:

defaultFilters - comma-separated list of filters (possible values are 'averaged', 'showFailed')

getHiddenFilters

@NotNull
public String getHiddenFilters()

Returns:

list of hidden filters

setHiddenFilters

public void setHiddenFilters(String hiddenFilters)

Set list of filters which should not be visible

Parameters:

hiddenFilters - comma-separated list of filters (possible values are 'all', 'averaged', 'showFailed', 'range', 'series' )

getProperties

public Map<String,String> getProperties()

setProperties

public void setProperties(Map<String,String> properties)

getValueTypes

public List<jetbrains.buildServer.web.statistics.graph.GraphBean.ValueTypeBean> getValueTypes()

Returns:

list of configured data series for the graph (list of value type descriptors)

addValueType

public jetbrains.buildServer.web.statistics.graph.GraphBean.ValueTypeBean addValueType(String key,
                                                                                       String description,
                                                                                       @Nullable
                                                                                       String buildTypeId)

Adds nested value type bean, which describes another named series of data on the graph

Parameters:

key - key for the value type

description - series name

buildTypeId - build configuration id this value provider should be bound to

Returns:

added bean

See Also:

ValueProvider.getKey()

addValueType

public jetbrains.buildServer.web.statistics.graph.GraphBean.ValueTypeBean addValueType(String key,
                                                                                       String description,
                                                                                       @Nullable
                                                                                       String buildTypeId,
                                                                                       @Nullable
                                                                                       String color)

Adds nested value type bean, which describes another named series of data on the graph

Parameters:

key - key for the value type

description - series name

buildTypeId - build configuration id this value provider should be bound to

color - custom series color

Returns:

added bean

See Also:

ValueProvider.getKey()

readFrom

public void readFrom(org.jdom.Element element)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object