org.hackystat.sensor.ant.dependencyfinder
Class DependencyFinderSensor

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.hackystat.sensor.ant.task.HackystatSensorTask
              extended by org.hackystat.sensor.ant.dependencyfinder.DependencyFinderSensor
All Implemented Interfaces:
java.lang.Cloneable

public class DependencyFinderSensor
extends HackystatSensorTask

Implements an Ant task that parses the XML files generated by DependencyFinder. The Ant Task sends the Coupling data to a Hackystat server.

Author:
Philip Johnson

Field Summary
 
Fields inherited from class org.hackystat.sensor.ant.task.HackystatSensorTask
dataFilesList, errMsgPrefix, failOnError, msgPrefix, runtime, sensorProps, sensorShell, sourceFilesList, toolAccount, tstampSet, verbose
 
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
DependencyFinderSensor()
          Initialize a new instance of this sensor.
DependencyFinderSensor(java.lang.String host, java.lang.String email, java.lang.String password)
          Initialize a new instance of this sensor for testing purposes.
 
Method Summary
 void executeInternal()
          Parses the tool's XML file and sends the resulting data to the SensorBase server.
(package private)  int processDependencyFinderXmlFile(java.io.File xmlFile)
          Processes a single DependencyFinder XML data file, generating sensor data.
 
Methods inherited from class org.hackystat.sensor.ant.task.HackystatSensorTask
createDataFiles, createSourceFiles, execute, getDataFiles, getFiles, getSourceFiles, info, isUsingUserMap, sendAndQuit, setFailOnError, setRetryAttempts, setRetryWaitInterval, setupSensorShell, setUserMapTool, setUserMapToolAccount, setVerbose, signalError, summaryInfo, verboseInfo
 
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

DependencyFinderSensor

public DependencyFinderSensor()
Initialize a new instance of this sensor.


DependencyFinderSensor

public DependencyFinderSensor(java.lang.String host,
                              java.lang.String email,
                              java.lang.String password)
Initialize a new instance of this sensor for testing purposes.

Parameters:
host - The SensorBase host URL.
email - The SensorBase email to use.
password - The SensorBase password to use.
Method Detail

executeInternal

public void executeInternal()
                     throws org.apache.tools.ant.BuildException
Parses the tool's XML file and sends the resulting data to the SensorBase server.

Specified by:
executeInternal in class HackystatSensorTask
Throws:
org.apache.tools.ant.BuildException - If there is an error.

processDependencyFinderXmlFile

int processDependencyFinderXmlFile(java.io.File xmlFile)
                             throws org.apache.tools.ant.BuildException
Processes a single DependencyFinder XML data file, generating sensor data.

Parameters:
xmlFile - The file containing the DependencyFinder data.
Returns:
The number of Coupling instances generated.
Throws:
org.apache.tools.ant.BuildException - If problems occur.