org.hackystat.telemetry.analyzer.reducer.impl
Class ChurnReducer

java.lang.Object
  extended by org.hackystat.telemetry.analyzer.reducer.impl.ChurnReducer
All Implemented Interfaces:
TelemetryReducer

public class ChurnReducer
extends java.lang.Object
implements TelemetryReducer

Returns a single stream providing Churn data. Churn is linesAdded + linesDeleted.

Options:

  1. member: The project member whose churn data is to be returned, or "*" for all members.
  2. isCumulative: True or false. Default is false.

Author:
Philip Johnson

Constructor Summary
ChurnReducer()
           
 
Method Summary
 TelemetryStreamCollection compute(org.hackystat.sensorbase.resource.projects.jaxb.Project project, org.hackystat.dailyprojectdata.client.DailyProjectDataClient dpdClient, org.hackystat.utilities.time.interval.Interval interval, java.lang.String[] options)
          Computes and returns the required telemetry streams object.
(package private)  java.lang.Long getData(org.hackystat.dailyprojectdata.client.DailyProjectDataClient dpdClient, org.hackystat.sensorbase.resource.projects.jaxb.Project project, org.hackystat.utilities.time.period.Day startDay, org.hackystat.utilities.time.period.Day endDay, java.lang.String member)
          Returns a Churn value for the specified time interval, or null if no Churn SensorData.
(package private)  TelemetryStream getStream(org.hackystat.dailyprojectdata.client.DailyProjectDataClient dpdClient, org.hackystat.sensorbase.resource.projects.jaxb.Project project, org.hackystat.utilities.time.interval.Interval interval, java.lang.String member, boolean isCumulative, java.lang.Object streamTagValue)
          Gets the telemetry stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChurnReducer

public ChurnReducer()
Method Detail

compute

public TelemetryStreamCollection compute(org.hackystat.sensorbase.resource.projects.jaxb.Project project,
                                         org.hackystat.dailyprojectdata.client.DailyProjectDataClient dpdClient,
                                         org.hackystat.utilities.time.interval.Interval interval,
                                         java.lang.String[] options)
                                  throws TelemetryReducerException
Computes and returns the required telemetry streams object.

Specified by:
compute in interface TelemetryReducer
Parameters:
project - The project.
dpdClient - The DPD Client.
interval - The interval.
options - The optional parameters.
Returns:
Telemetry stream collection.
Throws:
TelemetryReducerException - If there is any error.

getStream

TelemetryStream getStream(org.hackystat.dailyprojectdata.client.DailyProjectDataClient dpdClient,
                          org.hackystat.sensorbase.resource.projects.jaxb.Project project,
                          org.hackystat.utilities.time.interval.Interval interval,
                          java.lang.String member,
                          boolean isCumulative,
                          java.lang.Object streamTagValue)
                    throws java.lang.Exception
Gets the telemetry stream.

Parameters:
dpdClient - The DailyProjectData client we will contact for the data.
project - The project.
interval - The interval.
member - The member, or "*" for all members.
isCumulative - True for cumulative measure.
streamTagValue - The tag for the generated telemetry stream.
Returns:
The telemetry stream as required.
Throws:
java.lang.Exception - If there is any error.

getData

java.lang.Long getData(org.hackystat.dailyprojectdata.client.DailyProjectDataClient dpdClient,
                       org.hackystat.sensorbase.resource.projects.jaxb.Project project,
                       org.hackystat.utilities.time.period.Day startDay,
                       org.hackystat.utilities.time.period.Day endDay,
                       java.lang.String member)
                 throws TelemetryReducerException
Returns a Churn value for the specified time interval, or null if no Churn SensorData.

Parameters:
dpdClient - The DailyProjectData client we will use to get this data.
project - The project.
startDay - The start day (inclusive).
endDay - The end day (inclusive).
member - The member email, or "*" for all members.
Returns:
The Churn count, or null if there is no Commit SensorData for that time period.
Throws:
TelemetryReducerException - If anything goes wrong.