com.atlassian.greenhopper.model.timetracking
Class TimelineAnalysis

java.lang.Object
  com.atlassian.greenhopper.model.timetracking.TimelineAnalysis

public class TimelineAnalysis
extends java.lang.Object

Carries data collected during the timeline computation. This is used behind the Timeline Analysis view. Basically the concept follows that of a logger - it'll be passed around throughout the computation and information will be added. The object can be created in a disabled state for production runs. This allows us to keep that state internally and evade "if(isenabled)" in the calling code. It stores data from the timeline, and reasons behind the calculation.

Author:

ahennecke

Nested Class Summary

static class	TimelineAnalysis.DayAnalysis Keeps the two values we're interested in - time spent and remaining estimate.
static class	TimelineAnalysis.ValueSource Keeps the reason we've got for picking up a particular value.

Constructor Summary

TimelineAnalysis(boolean enabled)

TimelineAnalysis(boolean enabled, org.joda.time.DateMidnight start, org.joda.time.DateMidnight end)

Method Summary

void	addInitialValueSource(com.atlassian.jira.issue.Issue issue, TimelineAnalysis.ValueSource.ValueSourceType type, java.lang.Object... values) Info for the planning day computation
void	addValueSource(com.atlassian.jira.issue.Issue issue, org.joda.time.DateMidnight day, TimelineAnalysis.ValueSource.ValueSourceType type, java.lang.Object... values) Add some information on why we're picking up particular values
java.util.Map<com.atlassian.jira.issue.Issue,java.util.SortedMap<org.joda.time.DateMidnight,TimelineAnalysis.DayAnalysis>>	getData()
org.joda.time.DateMidnight	getEnd()
java.util.Map<com.atlassian.jira.issue.Issue,TimelineAnalysis.DayAnalysis>	getInitialValueData()
org.joda.time.DateMidnight	getStart()
WorklogTimeline	getTimeline()
void	importTimeline(WorklogTimeline timeline, java.util.List<com.atlassian.jira.issue.Issue> issues, org.joda.time.DateMidnight start, org.joda.time.DateMidnight end) pick up the computed timeline and
boolean	isEnabled()
void	setInitialValueRemainingEstimate(com.atlassian.jira.issue.Issue issue, java.lang.Long remainingEstimate) The RE we came up with for the planning day (x=0 in the chart)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineAnalysis

public TimelineAnalysis(boolean enabled)

TimelineAnalysis

public TimelineAnalysis(boolean enabled,
                        org.joda.time.DateMidnight start,
                        org.joda.time.DateMidnight end)

Method Detail

isEnabled

public boolean isEnabled()

addValueSource

public void addValueSource(com.atlassian.jira.issue.Issue issue,
                           org.joda.time.DateMidnight day,
                           TimelineAnalysis.ValueSource.ValueSourceType type,
                           java.lang.Object... values)

Add some information on why we're picking up particular values

addInitialValueSource

public void addInitialValueSource(com.atlassian.jira.issue.Issue issue,
                                  TimelineAnalysis.ValueSource.ValueSourceType type,
                                  java.lang.Object... values)

Info for the planning day computation

setInitialValueRemainingEstimate

public void setInitialValueRemainingEstimate(com.atlassian.jira.issue.Issue issue,
                                             java.lang.Long remainingEstimate)

The RE we came up with for the planning day (x=0 in the chart)

importTimeline

public void importTimeline(WorklogTimeline timeline,
                           java.util.List<com.atlassian.jira.issue.Issue> issues,
                           org.joda.time.DateMidnight start,
                           org.joda.time.DateMidnight end)

pick up the computed timeline and

getData

public java.util.Map<com.atlassian.jira.issue.Issue,java.util.SortedMap<org.joda.time.DateMidnight,TimelineAnalysis.DayAnalysis>> getData()

getInitialValueData

public java.util.Map<com.atlassian.jira.issue.Issue,TimelineAnalysis.DayAnalysis> getInitialValueData()

getStart

public org.joda.time.DateMidnight getStart()

getEnd

public org.joda.time.DateMidnight getEnd()

getTimeline

public WorklogTimeline getTimeline()