com.atlassian.greenhopper.model.charts
Class HourBurndownModel

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.TreeMap<org.joda.time.DateMidnight,HourBurndownEntry>
          com.atlassian.greenhopper.model.charts.HourBurndownModel

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<org.joda.time.DateMidnight,HourBurndownEntry>, java.util.NavigableMap<org.joda.time.DateMidnight,HourBurndownEntry>, java.util.SortedMap<org.joda.time.DateMidnight,HourBurndownEntry>

public class HourBurndownModel
extends java.util.TreeMap<org.joda.time.DateMidnight,HourBurndownEntry>

This is the model for an hour burndown chart. For each day in the iteration, it contains an entry with the according cumulative values.

Author:

ahennecke

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

HourBurndownModel()

Method Summary

HourBurndownEntry	getFirstValue()
HourBurndownEntry	getInitialValue()
java.lang.String	getLabelX()
java.lang.String	getLabelY()
HourBurndownEntry	getLastValue()
HourBurndownEntry	getPreviousDayDelta(org.joda.time.DateMidnight day) computes the delta towards the previous day.
void	setInitialValue(HourBurndownEntry initialValue)
void	setLabelX(java.lang.String labelX)
void	setLabelY(java.lang.String labelY)

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty

Constructor Detail

HourBurndownModel

public HourBurndownModel()

Method Detail

getLabelX

public java.lang.String getLabelX()

setLabelX

public void setLabelX(java.lang.String labelX)

getLabelY

public java.lang.String getLabelY()

setLabelY

public void setLabelY(java.lang.String labelY)

setInitialValue

public void setInitialValue(HourBurndownEntry initialValue)

getInitialValue

public HourBurndownEntry getInitialValue()

Returns:

the initial value, which is the data at the end of the day before sprint started.

getFirstValue

public HourBurndownEntry getFirstValue()

Returns:

the first entry of the model, or the initialValue if the map is empty

getLastValue

public HourBurndownEntry getLastValue()

Returns:

the last entry of the model, or the initialValue if the map is empty

getPreviousDayDelta

public HourBurndownEntry getPreviousDayDelta(org.joda.time.DateMidnight day)

computes the delta towards the previous day. So for example, if we have a remaining estimate of 10 on the given day, and had 15 on the previous day, the delta object will contain 5.

Parameters:

day - : the day to compute the delta from

Returns:

new HourBurndownEntry with the delta values against the previous day, or null if there is no entry for the given day.