com.gooddata.pivotal

Class PivotalApi

java.lang.Object

com.gooddata.pivotal.PivotalApi

public class PivotalApi
extends Object

GoodData Pivotal API wrapper

Version:

1.0

Author:

zd

Field Summary

Fields

Modifier and Type	Field and Description
protected DecimalFormat	decf

Constructor Summary

Constructors

Constructor and Description
PivotalApi(String usr, String psw, String prjId) The Pivotal API wrapper constructor

Method Summary

Modifier and Type	Method and Description
void	computeIterationVelocity(String csvFile, int velocityIterationCount, Map<Integer,String> velocities, Map<String,String> releaseInfo) Computes the iteration velocity
void	getCsvData(String ptCsv) Retrieves the PT data in the CSV format
String	getPassword()
String	getProjectId()
void	getToken() Get token
String	getUserName()
void	parse(String csvFile, String storiesCsv, String labelsCsv, String labelsToStoriesCsv, org.joda.time.DateTime t, int velocityIterationCount) Parses the PT CSV file into the STORY, LABEL, and LABEL_TO_STORY CSV files
void	setPassword(String password)
void	setProjectId(String projectId)
void	setUserName(String userName)
void	signin() Sign into the PT

Methods inherited from class java.lang.Object

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

Field Detail

decf

protected DecimalFormat decf

Constructor Detail

PivotalApi

public PivotalApi(String usr,
                  String psw,
                  String prjId)

The Pivotal API wrapper constructor

Parameters:

usr - - PT username

psw - - PT password

prjId - - PT project ID (integer)

Method Detail

getToken

public void getToken()
              throws IOException

Get token

Throws:

Exception - in case of an IO error

IOException

signin

public void signin()
            throws IOException

Sign into the PT

Throws:

Exception - in case of an IO error

IOException

getCsvData

public void getCsvData(String ptCsv)
                throws IOException

Retrieves the PT data in the CSV format

Parameters:

ptCsv - - the filename to store the PT CSV data

Throws:

Exception - in case of an IO error

IOException

computeIterationVelocity

public void computeIterationVelocity(String csvFile,
                                     int velocityIterationCount,
                                     Map<Integer,String> velocities,
                                     Map<String,String> releaseInfo)
                              throws IOException

Computes the iteration velocity

Parameters:

csvFile - the incoming PT CSV file

velocityIterationCount - the number of iterations that the velocity is computed from

velocities - returned velocities

releaseInfo - releases

Throws:

Exception - in case of an IO issue

IOException

parse

public void parse(String csvFile,
                  String storiesCsv,
                  String labelsCsv,
                  String labelsToStoriesCsv,
                  org.joda.time.DateTime t,
                  int velocityIterationCount)
           throws IOException

Parses the PT CSV file into the STORY, LABEL, and LABEL_TO_STORY CSV files

Parameters:

csvFile - the incoming PT CSV file

storiesCsv - the output STORY CSV file

labelsCsv - the output LABEL CSV file

labelsToStoriesCsv - the output LABEL_TO_STORY CSV file

velocityIterationCount - the number of iterations that the velocity is computed from

Throws:

Exception - in case of an IO issue

IOException

getUserName

public String getUserName()

setUserName

public void setUserName(String userName)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getProjectId

public String getProjectId()

setProjectId

public void setProjectId(String projectId)