org.jcoderz.phoenix.report
Class JcSummaryReportAntTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.jcoderz.phoenix.report.JcSummaryReportAntTask

All Implemented Interfaces:

Cloneable

public class JcSummaryReportAntTask
extends org.apache.tools.ant.Task

This is the Ant task for the Jcoderz Summary Report. This task uses a summary database file to create progress diagrams showing the historical changes of the number of findings. TODO: Separate into Command Line tool and Ant Task so that the java.awt.headless property can be set by the Ant Task.

1. Read the summary db file or create a new one if none exists.
2. Check whether new folders have been created in the basedir.
3. Update the summary db file with the information from new folders.
4. Generate the diagrams based on the summary information.

Author:

Michael Rumpf

Nested Class Summary

static class

JcSummaryReportAntTask.JcoderReportFilter Filter for folders that contain a 'summary.xml' file.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

JcSummaryReportAntTask()

Method Summary

void	execute() This method is called by Ant for executing this task.
void	setBaseDir(String base) Sets the base directory of the reports.
void	setDest(String dest) Sets the destination of the report.
void	setName(String name) Sets the name of the summary report.
void	setSummary(String summary) Sets the historic database file.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

JcSummaryReportAntTask

public JcSummaryReportAntTask()

Method Detail

setName

public void setName(String name)

Sets the name of the summary report.

Parameters:

name - the report name.

setDest

public void setDest(String dest)

Sets the destination of the report.

Parameters:

dest - the report destination.

setBaseDir

public void setBaseDir(String base)

Sets the base directory of the reports.

Parameters:

base - the base directory.

setSummary

public void setSummary(String summary)

Sets the historic database file.

Parameters:

summary - the historic database file.

execute

public void execute()
             throws org.apache.tools.ant.BuildException

This method is called by Ant for executing this task.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - whenver a problem occurs.