com.pyxis.greenhopper.gadget
Class ChartDataResource

java.lang.Object
  com.pyxis.greenhopper.gadget.AbstractGadgetResource
      com.pyxis.greenhopper.gadget.ChartDataResource

public class ChartDataResource
extends AbstractGadgetResource

Generation and validation resource for chart gadgets

TODO unify validation code

Nested Class Summary

static class	ChartDataResource.ChartCurveData
static class	ChartDataResource.ChartData
static class	ChartDataResource.ChartInfo
static class	ChartDataResource.ContextInfo10
static class	ChartDataResource.DataPoint
static class	ChartDataResource.LegendEntry

Field Summary

protected static java.lang.String	CHART_TYPE
protected static java.lang.String	CONTEXT_ID
protected static java.lang.String	CONTEXTS
protected static java.lang.String	FIELD_ID
protected static java.lang.String	NO_VALUE
protected static java.lang.String	PROJECT_ID
protected static java.lang.String	PROJECT_KEY Legacy, here to make validation on hour burndown gadget work.
protected static java.lang.String	VERSION_ID
protected static java.lang.String	VERSIONS Legacy, here to make validation on hour burndown gadget work.

Fields inherited from class com.pyxis.greenhopper.gadget.AbstractGadgetResource

PROJECT_PREFIX

Constructor Summary

ChartDataResource(com.atlassian.jira.project.ProjectManager projectManager, com.atlassian.jira.security.PermissionManager permissionManager, com.atlassian.jira.project.version.VersionManager versionManager, com.atlassian.jira.security.JiraAuthenticationContext authenticationContext, GreenHopperLicenseManager ghLicense)

Method Summary

javax.ws.rs.core.Response	generate(javax.servlet.http.HttpServletRequest request, java.lang.String projectIdString, java.lang.String versionIdString, java.lang.String contextId, java.lang.String contexts, java.lang.String watchedFieldId, java.lang.String chartType)
javax.ws.rs.core.Response	generateHourburndown(javax.servlet.http.HttpServletRequest request, java.lang.String projectIdString, java.lang.String versionIdString, java.lang.String contexts, java.lang.String chartType) Legacy method for the hourburndown gadget
com.pyxis.greenhopper.gadget.ChartDataResource.ChartCurveDataProvider	getChartCurveInputProvider(BoardContext boardContext, java.lang.String chartType, java.lang.String watchedFieldId) Get the right ChartCurveDataProvider for a given chart type.
javax.ws.rs.core.Response	validate(javax.servlet.http.HttpServletRequest request, java.lang.String projectId, java.lang.String versionId, java.lang.String contextId, java.lang.String contexts, java.lang.String watchedFieldId) New Validation method, uses correct field names
javax.ws.rs.core.Response	validateHourburndown(javax.servlet.http.HttpServletRequest request, java.lang.String projectKey, java.lang.String versionString, java.lang.String contexts) Legacy method for the hourburndown gadget.

Methods inherited from class com.pyxis.greenhopper.gadget.AbstractGadgetResource

createErrorResponse, createIndexingUnavailableResponse, createOkResponse, createValidationResponse, response

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_KEY

protected static final java.lang.String PROJECT_KEY

Legacy, here to make validation on hour burndown gadget work.

See Also:

Constant Field Values

PROJECT_ID

protected static final java.lang.String PROJECT_ID

See Also:

Constant Field Values

VERSIONS

protected static final java.lang.String VERSIONS

Legacy, here to make validation on hour burndown gadget work.

See Also:

Constant Field Values

VERSION_ID

protected static final java.lang.String VERSION_ID

See Also:

Constant Field Values

CONTEXTS

protected static final java.lang.String CONTEXTS

See Also:

Constant Field Values

CONTEXT_ID

protected static final java.lang.String CONTEXT_ID

See Also:

Constant Field Values

CHART_TYPE

protected static final java.lang.String CHART_TYPE

See Also:

Constant Field Values

FIELD_ID

protected static final java.lang.String FIELD_ID

See Also:

Constant Field Values

NO_VALUE

protected static final java.lang.String NO_VALUE

See Also:

Constant Field Values

Constructor Detail

ChartDataResource

public ChartDataResource(com.atlassian.jira.project.ProjectManager projectManager,
                         com.atlassian.jira.security.PermissionManager permissionManager,
                         com.atlassian.jira.project.version.VersionManager versionManager,
                         com.atlassian.jira.security.JiraAuthenticationContext authenticationContext,
                         GreenHopperLicenseManager ghLicense)

Method Detail

validateHourburndown

public javax.ws.rs.core.Response validateHourburndown(@Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      java.lang.String projectKey,
                                                      java.lang.String versionString,
                                                      java.lang.String contexts)

Legacy method for the hourburndown gadget. Reason is that the variables are called projectKey and versions, instead of projectId and versionId

Parameters:

request - http data.

projectKey - Key for project being queried

versionString - Version name, malformed version names are treated as errors. if empty then the next available version is taken.

contexts - Comma-delimited list of context names, malformed context names get treated as the default context if empty then the default context is used. duplicate contexts are ignored.

Returns:

A Response whose status is 200 on success, 400 on error. On error, its' payload is a JaxbErrorCollection, on success it has no payload

validate

public javax.ws.rs.core.Response validate(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          java.lang.String projectId,
                                          java.lang.String versionId,
                                          java.lang.String contextId,
                                          java.lang.String contexts,
                                          java.lang.String watchedFieldId)

New Validation method, uses correct field names

generateHourburndown

public javax.ws.rs.core.Response generateHourburndown(@Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      java.lang.String projectIdString,
                                                      java.lang.String versionIdString,
                                                      java.lang.String contexts,
                                                      java.lang.String chartType)

Legacy method for the hourburndown gadget

Parameters:

request -

projectIdString -

versionIdString -

contexts -

chartType -

generate

public javax.ws.rs.core.Response generate(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          java.lang.String projectIdString,
                                          java.lang.String versionIdString,
                                          java.lang.String contextId,
                                          java.lang.String contexts,
                                          java.lang.String watchedFieldId,
                                          java.lang.String chartType)

Parameters:

request - http data.

projectIdString - Key for project being queried

versionIdString - Version name, malformed version names are treated as errors. if empty then the next available version is taken.

contexts - Comma-delimited list of context names, malformed context names get treated as the default context if empty then the default context is used. duplicate contexts are ignored.

Returns:

A Response whose status is 200 on success, 400 on error. On error, its' payload is a JaxbErrorCollection, on success its' payload is a BurndownData containing the data required to generate the burndown chart.

getChartCurveInputProvider

public com.pyxis.greenhopper.gadget.ChartDataResource.ChartCurveDataProvider getChartCurveInputProvider(BoardContext boardContext,
                                                                                                        java.lang.String chartType,
                                                                                                        java.lang.String watchedFieldId)

Get the right ChartCurveDataProvider for a given chart type.

Parameters:

boardContext -

chartType -

watchedFieldId -