com.atlassian.greenhopper.service.charts
Interface HourBurndownChartService

All Known Implementing Classes:

HourBurndownChartServiceImpl

public interface HourBurndownChartService

This service is responsible for converting raw data into Model classes for the respective charts.

Author:

ahennecke

Field Summary

static java.lang.String

SERVICE

Method Summary

HourBurndownModel	getAggregatedHourBurndown(GHVersion iteration, com.atlassian.crowd.embedded.api.User user, ChartBoard board) Build the HourBurndownModel for a parent iteration.
HourBurndownModel	getAggregatedHourBurndown(com.atlassian.crowd.embedded.api.User user, HourBurndownSpan burndownSpan, HourBurndownSpanMapper hourBurndownSpanMapper)
HourBurndownModel	getHourBurndown(java.util.List<com.atlassian.jira.issue.Issue> issues, com.atlassian.crowd.embedded.api.User user, org.joda.time.DateMidnight startDate, org.joda.time.DateMidnight endDate) Build the HourBurndownModel for the given data.
TimelineAnalysis	getHourBurndownAnalysis(java.util.List<com.atlassian.jira.issue.Issue> issues, com.atlassian.crowd.embedded.api.User user, org.joda.time.DateMidnight startDate, org.joda.time.DateMidnight endDate)
java.util.Map<java.lang.String,IssueReport>	getHourBurndownReport(java.util.List<com.atlassian.jira.issue.Issue> issues, com.atlassian.crowd.embedded.api.User user, org.joda.time.DateMidnight startDate, org.joda.time.DateMidnight endDate, ChartContext chartContext) Build a Map of IssueReport items for all given issues, with the remaining estimate values set for each day in the sprint.
HourBurndownEntry	getInitialValue(com.atlassian.crowd.embedded.api.User user, WorklogTimeline timeline, java.util.List<com.atlassian.jira.issue.Issue> issues, org.joda.time.DateMidnight startDate)
HourBurndownEntry	getInitialValue(com.atlassian.crowd.embedded.api.User user, WorklogTimeline timeline, java.util.List<com.atlassian.jira.issue.Issue> issues, org.joda.time.DateMidnight startDate, TimelineAnalysis analysis)

Field Detail

SERVICE

static final java.lang.String SERVICE

See Also:

Constant Field Values

Method Detail

getHourBurndown

HourBurndownModel getHourBurndown(java.util.List<com.atlassian.jira.issue.Issue> issues,
                                  com.atlassian.crowd.embedded.api.User user,
                                  org.joda.time.DateMidnight startDate,
                                  org.joda.time.DateMidnight endDate)

Build the HourBurndownModel for the given data. Based on the timeline extracted from the changelogs and worklogs, the model will contain aggregated data for each day, for all issues given. For details and limitations of timeline analysis in JIRA, see WorklogHistoryService. The model uses DateMidnight as a key, since the burndown charts are aggregated by day. Use DateUtils to convert if necessary. If dates are null, the current day will be used. TODO refactor method signature once model refactoring and contextual data service are done

Parameters:

issues - : The issues to build the chart model for. This can be a list of all issues in an iteration, or a filtered list.

user -

startDate - : The start date of the iteration, or null if not known

endDate - : The end date of the iteration, or null if not known

Returns:

Model with aggregated data by day.

getAggregatedHourBurndown

HourBurndownModel getAggregatedHourBurndown(GHVersion iteration,
                                            com.atlassian.crowd.embedded.api.User user,
                                            ChartBoard board)

Build the HourBurndownModel for a parent iteration. The aggregate model will collect the initial values of all subiterations as it's own initial value. This means that as soon as issues get estimated in subiterations, the remaining estimate will be added to the aggregate model and to the guideline as well. Time spent and estimate changes will be factored in on these aggregated lines on the days they occur.

Parameters:

iteration - : The parent iteration

user - : The current user

Returns:

Model with aggregated data by day and sub-iterations

getAggregatedHourBurndown

HourBurndownModel getAggregatedHourBurndown(com.atlassian.crowd.embedded.api.User user,
                                            HourBurndownSpan burndownSpan,
                                            HourBurndownSpanMapper hourBurndownSpanMapper)

getHourBurndownReport

java.util.Map<java.lang.String,IssueReport> getHourBurndownReport(java.util.List<com.atlassian.jira.issue.Issue> issues,
                                                                  com.atlassian.crowd.embedded.api.User user,
                                                                  org.joda.time.DateMidnight startDate,
                                                                  org.joda.time.DateMidnight endDate,
                                                                  ChartContext chartContext)

Build a Map of IssueReport items for all given issues, with the remaining estimate values set for each day in the sprint. Key is the issue key. If dates are null, the current day will be used.

Parameters:

issues - : The issues to build the report for

user -

startDate - : The start date of the iteration, or null if not known

endDate - : The end date of the iteration, or null if not known

getInitialValue

HourBurndownEntry getInitialValue(com.atlassian.crowd.embedded.api.User user,
                                  WorklogTimeline timeline,
                                  java.util.List<com.atlassian.jira.issue.Issue> issues,
                                  org.joda.time.DateMidnight startDate,
                                  TimelineAnalysis analysis)

getInitialValue

HourBurndownEntry getInitialValue(com.atlassian.crowd.embedded.api.User user,
                                  WorklogTimeline timeline,
                                  java.util.List<com.atlassian.jira.issue.Issue> issues,
                                  org.joda.time.DateMidnight startDate)

getHourBurndownAnalysis

TimelineAnalysis getHourBurndownAnalysis(java.util.List<com.atlassian.jira.issue.Issue> issues,
                                         com.atlassian.crowd.embedded.api.User user,
                                         org.joda.time.DateMidnight startDate,
                                         org.joda.time.DateMidnight endDate)