Index (JCVSReport API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

A B C D E F G H I J M P R S T U W

A

addCvsOperation(History) - Method in class ca.utoronto.JCVSReport.MetricDatabase: Update the database by adding the cvs operation captured by the given history record.
addGraph(String) - Method in class ca.utoronto.JCVSReport.report.Report: Add a graph to this report
addGraphs(String[]) - Method in class ca.utoronto.JCVSReport.report.Report: Add in a set of graphs
addMetric(String) - Method in class ca.utoronto.JCVSReport.metric.MetricSet: Add a metric to this metricSet

B

BarGraph - class ca.utoronto.JCVSReport.report.BarGraph.: Show how much each developer contributes to several metrics over time using a bar graph
BarGraph() - Constructor for class ca.utoronto.JCVSReport.report.BarGraph
BasicGraph - class ca.utoronto.JCVSReport.report.BasicGraph.: An abstract base class for representing a single graph.
BasicGraph() - Constructor for class ca.utoronto.JCVSReport.report.BasicGraph
BasicMetric - class ca.utoronto.JCVSReport.metric.BasicMetric.: Gather one metric from a revision of a file and add it to the Bloof database
BasicMetric() - Constructor for class ca.utoronto.JCVSReport.metric.BasicMetric
build(MetricDatabase) - Method in class ca.utoronto.JCVSReport.report.GraphBuilder: Build and initialize a new graph object
byDeveloper() - Static method in class ca.utoronto.JCVSReport.metric.MetricRevision: Sort this metric by metric name and developer Note: this comparator imposes orderings that are inconsistent with equals
byFile() - Static method in class ca.utoronto.JCVSReport.metric.MetricRevision: Sort this metric by metric name and file Note: this comparator imposes orderings that are inconsistent with equals

C

Config - class ca.utoronto.JCVSReport.Config.: The Config class parses the user specified config file and provides methods for accessing the user defined properties.
Config() - Constructor for class ca.utoronto.JCVSReport.Config
Cvs - class ca.utoronto.JCVSReport.cvsPlugin.Cvs.: Cvs class acts as an interface to the CVS.
Cvs(CvsAccess) - Constructor for class ca.utoronto.JCVSReport.cvsPlugin.Cvs: Creates a Cvs object with the given CVS access information.
ca.utoronto.JCVSReport - package ca.utoronto.JCVSReport
ca.utoronto.JCVSReport.cvsPlugin - package ca.utoronto.JCVSReport.cvsPlugin
ca.utoronto.JCVSReport.metric - package ca.utoronto.JCVSReport.metric
ca.utoronto.JCVSReport.report - package ca.utoronto.JCVSReport.report
ca.utoronto.SimpleProcess - package ca.utoronto.SimpleProcess
close() - Method in class ca.utoronto.JCVSReport.MetricDatabase: Close the metric database
closeProject() - Method in class ca.utoronto.JCVSReport.JCVSProject: Close the database.
countMatches(String, Pattern) - Method in class ca.utoronto.JCVSReport.metric.RegexLineCounter: Returns number of newlines matched by a specified regular expression
countMatches(String, Pattern) - Method in class ca.utoronto.JCVSReport.metric.RegexMatchCounter: Returns number of matches for a specified regular expression
countMatches(String, Pattern) - Method in class ca.utoronto.JCVSReport.metric.SyntaxTreeRegexMatchCounter: Returns number of matches for a specified regular expression in the Java Syntax Tree parsed from the specified string
cvs() - Method in class ca.utoronto.JCVSReport.Config: Read the location of a CVS repository

D

database - Variable in class ca.utoronto.JCVSReport.report.BasicGraph
db() - Method in class ca.utoronto.JCVSReport.Config: Find out where our SQL database is located
devMap - Variable in class ca.utoronto.JCVSReport.report.BasicGraph

E

equals(History) - Method in class ca.utoronto.JCVSReport.cvsPlugin.History: Compare this History object to the other History object.
executeQuery() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Execute our data gathering query If the user specifies an SQL query in the properties file for this graph, then we will use it.

F

fileMap - Variable in class ca.utoronto.JCVSReport.report.BasicGraph

G

Graph - interface ca.utoronto.JCVSReport.report.Graph.: Write a single graph out to an HTML file
GraphBuilder - class ca.utoronto.JCVSReport.report.GraphBuilder.: Create new graph objects based on a descriptive string
GraphBuilder(String) - Constructor for class ca.utoronto.JCVSReport.report.GraphBuilder: Create a new GraphLoader object for creating graphs described by the specified graphString
getChart() - Method in class ca.utoronto.JCVSReport.report.BarGraph: Build a chart from a seriesCollection
getChart() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Build a chart from a dataset
getChart() - Method in class ca.utoronto.JCVSReport.report.PieGraph: Build a chart from a dataset
getChart() - Method in class ca.utoronto.JCVSReport.report.TimeSeriesGraph: Build a chart from a seriesCollection
getCvsFile(String, String) - Method in class ca.utoronto.JCVSReport.cvsPlugin.Cvs: Get a specific version of a specific file from a CVS repository
getCvsHistoryData() - Method in class ca.utoronto.JCVSReport.cvsPlugin.Cvs: Get project data from the CVS history for the whole lifetime of the project.
getCvsHistoryData(Date) - Method in class ca.utoronto.JCVSReport.cvsPlugin.Cvs: Get project data from the CVS history from the specified date.
getCvsLogData() - Method in class ca.utoronto.JCVSReport.cvsPlugin.Cvs: Get project data from the CVS log for the whole lifetime of the project.
getCvsLogData(Date) - Method in class ca.utoronto.JCVSReport.cvsPlugin.Cvs: Get project data from the CVS log from the specified date.
getDataset() - Method in class ca.utoronto.JCVSReport.report.BarGraph: Build a dataset object from an SQL query NOTE: We assume that the SQL query returns values sorted by date
getDataset() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Build a dataset object from an SQL query
getDataset() - Method in class ca.utoronto.JCVSReport.report.TimeSeriesGraph: Build a seriesCollection object from an SQL query NOTE: We assume that the SQL query returns values sorted by date
getDay() - Method in class ca.utoronto.JCVSReport.metric.MetricRevision: Get the timestamp as a day
getDeveloper() - Method in class ca.utoronto.JCVSReport.metric.MetricRevision: Get the metric value
getDouble(Object) - Method in class ca.utoronto.JCVSReport.metric.MetricRevisionMap: Get the number associated with a revision object
getFile() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
getFile() - Method in class ca.utoronto.JCVSReport.metric.MetricRevision: Get the filename
getGraphNames() - Method in class ca.utoronto.JCVSReport.Config: Get the names of the reports
getGraphs() - Method in class ca.utoronto.JCVSReport.report.Report: Get a list of the graphs
getHeight() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get the desired height of the chart
getHistory() - Method in class ca.utoronto.JCVSReport.cvsPlugin.HistoryParser
getJavaSyntaxTree(Reader) - Method in class ca.utoronto.JCVSReport.metric.SyntaxTreeRegexMatchCounter: Convert Java source code into an abstract syntax tree
getKey(MetricRevision) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get the key attribute of a MetricRevision object.
getKeys() - Method in class ca.utoronto.JCVSReport.metric.MetricGraphProperties: Get a list of the keys supported by this bundle
getMetricName() - Method in class ca.utoronto.JCVSReport.metric.MetricRevision: Get the title
getMetricNames() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get a list of the metrics supported by this graph
getMetricNames() - Method in interface ca.utoronto.JCVSReport.report.Graph: Get a list of metrics supported by this graph
getMetricValue() - Method in class ca.utoronto.JCVSReport.metric.MetricRevision: Get the metric value
getOperation() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
getPath() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
getProperty(String) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get a property from the props resource bundle
getProperty(String, String) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get a property from the props resource bundle (return defaultValue if the property does not exist)
getQualifiedFilename() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
getReport() - Method in class ca.utoronto.JCVSReport.JCVSProject: Access the internal report object
getRevision() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
getRevisionId(String, String) - Method in class ca.utoronto.JCVSReport.MetricDatabase: Query the revision id of the file given the file pathname and version.
getSeriesLabel(MetricRevision) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get the label of a series on a graph from a MetricRevision object.
getStoredMetricValue(MetricRevision) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get the stored metric value associated with the specified MetricRevision
getTimestamp() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
getTimestamp() - Method in class ca.utoronto.JCVSReport.metric.MetricRevision: Get the timestamp
getTitle() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get the title of the object
getTitle() - Method in interface ca.utoronto.JCVSReport.report.Graph: Get the title of the graph
getTitle() - Method in class ca.utoronto.JCVSReport.report.TimeSeriesGraph: Get the title of the graph object
getUser() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
getWidth() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get the desired width of the chart
getXLabel() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get the label for the x-axis
getYLabel() - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Get the label for the y-axis

H

History - class ca.utoronto.JCVSReport.cvsPlugin.History.: History is a container class for a single CVS history record.
History() - Constructor for class ca.utoronto.JCVSReport.cvsPlugin.History
HistoryParser - class ca.utoronto.JCVSReport.cvsPlugin.HistoryParser.: Parser for the CVS history.
HistoryParser(Reader, String) - Constructor for class ca.utoronto.JCVSReport.cvsPlugin.HistoryParser: Creates a history parser with a given reader.
handleGetObject(String) - Method in class ca.utoronto.JCVSReport.metric.MetricGraphProperties: Get an object from the bundle with the specified key
hashCode() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History: hashCode.

I

id - Variable in class ca.utoronto.JCVSReport.metric.BasicMetric
id - Variable in class ca.utoronto.JCVSReport.report.BasicGraph
importCvsMetadata() - Method in class ca.utoronto.JCVSReport.UpdateStatistics: Import the cvs metadata to the database
importProject() - Method in class ca.utoronto.JCVSReport.JCVSProject: Imports a new project by creating a new database for it, and importing the CVS data for the whole lifetime of the project.
importStats(Report) - Method in class ca.utoronto.JCVSReport.UpdateStatistics: Import the statistics
incremental - Variable in class ca.utoronto.JCVSReport.report.BasicGraph
init(MetricDatabase, String, ResourceBundle) - Method in class ca.utoronto.JCVSReport.metric.BasicMetric: Initialize Metric object from properties file
init(MetricDatabase, String, ResourceBundle) - Method in interface ca.utoronto.JCVSReport.metric.Metric: Initialize Metric from properties file
init(MetricDatabase, String, ResourceBundle) - Method in class ca.utoronto.JCVSReport.metric.RegexMatchCounter: Initialize Metric from properties file
init(MetricDatabase, String, ResourceBundle) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Initialize Graph from properties file
init(MetricDatabase, String, ResourceBundle) - Method in interface ca.utoronto.JCVSReport.report.Graph: Initialize Graph from properties file
insertMetric - Variable in class ca.utoronto.JCVSReport.metric.BasicMetric
isDeletedFile(String) - Method in class ca.utoronto.JCVSReport.MetricDatabase: Checks if the file with the given path has been deleted from CVS.

J

JCVSProject - class ca.utoronto.JCVSReport.JCVSProject.: Represents a project with an associated database and CVS repository.
JCVSProject(CvsAccess, DbAccess, String[]) - Constructor for class ca.utoronto.JCVSReport.JCVSProject: Creates JCVSReport given database access and SCM access information.

M

Metric - interface ca.utoronto.JCVSReport.metric.Metric.: Gather one metric from a revision of a file and add it to the Bloof database
MetricDatabase - class ca.utoronto.JCVSReport.MetricDatabase.: A McKoi database for storing metrics based on statistics gathered from CVS repositories
MetricDatabase(Connection) - Constructor for class ca.utoronto.JCVSReport.MetricDatabase: Initialize from an existing connection
MetricGraphProperties - class ca.utoronto.JCVSReport.metric.MetricGraphProperties.: This class allows you to graph individual metrics without needing to provide a properties file.
MetricGraphProperties(String) - Constructor for class ca.utoronto.JCVSReport.metric.MetricGraphProperties: Create a new ResourceBundle for the specified metric
MetricRevision - class ca.utoronto.JCVSReport.metric.MetricRevision.: The result of a query for a metric in the Metric Database
MetricRevision(ResultSet) - Constructor for class ca.utoronto.JCVSReport.metric.MetricRevision: Initialize a MetricRevision object from the keys of a query
MetricRevision(List) - Constructor for class ca.utoronto.JCVSReport.metric.MetricRevision: Create a MetricRevision object from a list
MetricRevision(String, String, Timestamp, double, String) - Constructor for class ca.utoronto.JCVSReport.metric.MetricRevision: Create a MetricRevision object from a string
MetricRevisionMap - class ca.utoronto.JCVSReport.metric.MetricRevisionMap.: Store and retrieve metric values according to the specified Comparator object
MetricRevisionMap(Comparator) - Constructor for class ca.utoronto.JCVSReport.metric.MetricRevisionMap: Create a new MetricRevisionMap which uses the specified Comparator to sort values and determine equality
MetricSet - class ca.utoronto.JCVSReport.metric.MetricSet.: MetricSet: Gather a set of metric from a revision of a file and add it to the Bloof database
MetricSet(MetricDatabase) - Constructor for class ca.utoronto.JCVSReport.metric.MetricSet: Initialize our set of Metrics
main(String[]) - Static method in class ca.utoronto.JCVSReport.Presentation: Main subroutine
metricTitle(String) - Static method in class ca.utoronto.JCVSReport.metric.MetricSet: Get the title of a particular metric

P

PieGraph - class ca.utoronto.JCVSReport.report.PieGraph.: Show how much each developer contributes to a particular metric over time
PieGraph() - Constructor for class ca.utoronto.JCVSReport.report.PieGraph
Presentation - class ca.utoronto.JCVSReport.Presentation.: The Presentation component is the entry point of JCVSReport, i.e. this component is the main class that will be called when the user invokes JCVSReport via command line.
perDeveloper - Variable in class ca.utoronto.JCVSReport.report.BasicGraph
populateWithHistory(Iterator) - Method in class ca.utoronto.JCVSReport.MetricDatabase: Populate the database with CVS history data.
prepareStatement(String) - Method in class ca.utoronto.JCVSReport.MetricDatabase: Prepare an SQL statement for execution
processRevision(String, String) - Method in interface ca.utoronto.JCVSReport.metric.Metric: Process the contents of a revision of a file with each metric
processRevision(String, String) - Method in class ca.utoronto.JCVSReport.metric.MetricSet: Process the contents of a revision of a file with each metric
processRevision(String, String) - Method in class ca.utoronto.JCVSReport.metric.RegexMatchCounter: Process the contents of a revision of a file with this metric
processRevision(String, String) - Method in class ca.utoronto.JCVSReport.report.Report: Process the contents of a revision of a file with each metric
produceReport(String, String) - Method in class ca.utoronto.JCVSReport.JCVSProject: Produces an HTML report with the specified file name and in the specified directory.
props - Variable in class ca.utoronto.JCVSReport.metric.BasicMetric
props - Variable in class ca.utoronto.JCVSReport.report.BasicGraph
putDouble(Object, double) - Method in class ca.utoronto.JCVSReport.metric.MetricRevisionMap: Associate a revision with a number

R

RegexLineCounter - class ca.utoronto.JCVSReport.metric.RegexLineCounter.: RegexLineCounter: Class that is used to count number of newlines for the specified regular expression in the search string.
RegexLineCounter() - Constructor for class ca.utoronto.JCVSReport.metric.RegexLineCounter
RegexMatchCounter - class ca.utoronto.JCVSReport.metric.RegexMatchCounter.: Metric: Gather one metric from a revision of a file and add it to the Bloof database
RegexMatchCounter() - Constructor for class ca.utoronto.JCVSReport.metric.RegexMatchCounter
Report - class ca.utoronto.JCVSReport.report.Report.: Write a set of graphs out to an HTML file
Report(MetricDatabase) - Constructor for class ca.utoronto.JCVSReport.report.Report: Initialize a new Report object
run() - Method in class ca.utoronto.JCVSReport.cvsPlugin.HistoryParser
run(String[]) - Static method in class ca.utoronto.SimpleProcess.SimpleProcess: Run a process and return its result as a string
run() - Method in class ca.utoronto.SimpleProcess.StreamGobbler: Read the full contents of the given stream

S

SimpleProcess - class ca.utoronto.SimpleProcess.SimpleProcess.: SimpleProcess: A simpler interface for running external processes
SimpleProcess(String[]) - Constructor for class ca.utoronto.SimpleProcess.SimpleProcess: Create a new SimpleProcess object
StreamGobbler - class ca.utoronto.SimpleProcess.StreamGobbler.: StreamGobbler: Read and throw away the output of a stream
StreamGobbler(BufferedReader) - Constructor for class ca.utoronto.SimpleProcess.StreamGobbler: Create a new StreamGobbler object for reading the full contents of a stream
SyntaxTreeRegexMatchCounter - class ca.utoronto.JCVSReport.metric.SyntaxTreeRegexMatchCounter.: This class is an adaptation of RegexLineCounter, targeted towards parsing .java source files, by ways of Abstract Syntax Trees, via PMD.
SyntaxTreeRegexMatchCounter() - Constructor for class ca.utoronto.JCVSReport.metric.SyntaxTreeRegexMatchCounter
setAutoCommit(boolean) - Method in class ca.utoronto.JCVSReport.MetricDatabase: Sets auto commit to the given value.
setFile(String) - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
setOperation(String) - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
setPath(String) - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
setPerDeveloper(boolean) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Set whether we should report this metric per developer
setPerDeveloper(boolean) - Method in interface ca.utoronto.JCVSReport.report.Graph: Set whether we should report this metric per developer *
setRevision(String) - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
setTimestamp(Timestamp) - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
setUser(String) - Method in class ca.utoronto.JCVSReport.cvsPlugin.History
stderr() - Method in class ca.utoronto.SimpleProcess.SimpleProcess: Access the stderr stream for the process
stdout() - Method in class ca.utoronto.SimpleProcess.SimpleProcess: Access the stdout stream for the process
storeMetricValue(MetricRevision) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Store the value associated with the current metric result so that it can be retreived later
sum(String) - Method in class ca.utoronto.JCVSReport.metric.MetricRevisionMap: Retrieve sum of each metric

T

TimeSeriesGraph - class ca.utoronto.JCVSReport.report.TimeSeriesGraph.: A graph that displays the values of one or more metrics over time.
TimeSeriesGraph() - Constructor for class ca.utoronto.JCVSReport.report.TimeSeriesGraph
toString() - Method in class ca.utoronto.JCVSReport.cvsPlugin.History

U

UpdateStatistics - class ca.utoronto.JCVSReport.UpdateStatistics.: UpdateStatistics brings the statistics in the database up to date with the CVS repository.
UpdateStatistics(MetricDatabase, Cvs) - Constructor for class ca.utoronto.JCVSReport.UpdateStatistics: Creates UpdateStatistics given a database and a cvs.
updateCvsMetadata(Date) - Method in class ca.utoronto.JCVSReport.UpdateStatistics: Updates the database with cvs metadata starting at a particular date.
updateProject() - Method in class ca.utoronto.JCVSReport.JCVSProject: Updates the project since last time it has been updated.
updateStats(Report) - Method in class ca.utoronto.JCVSReport.UpdateStatistics: Update all of ring the statistics in the database up to date with the CVS repository. 1) Ask Bloof to update the database with the CVS metadata. 2) For each new revision, read the file into memory and gather the metrics that are needed for our current report

W

waitFor() - Method in class ca.utoronto.SimpleProcess.SimpleProcess: Wait for the process to exit
write(PrintWriter, File) - Method in class ca.utoronto.JCVSReport.report.BasicGraph: Write a chart to disk and link to it in an HTML file
write(PrintWriter, File) - Method in interface ca.utoronto.JCVSReport.report.Graph: Output this report to an HTML file
write(String, String) - Method in class ca.utoronto.JCVSReport.report.Report: Write reports to an output directory
write(PrintWriter, File) - Method in class ca.utoronto.JCVSReport.report.Report: Write reports to an output directory

A B C D E F G H I J M P R S T U W

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

JCVSReport: Easy Progress Reports for CVS/Java Projects. By David James.