com.unitesk.requality.report
Class ReportGenerator

java.lang.Object
  extended by com.unitesk.requality.report.ReportGenerator

public class ReportGenerator
extends java.lang.Object

This class is introduced as this var and all public methods can be used in freemarker template.


Constructor Summary
ReportGenerator()
           
 
Method Summary
 boolean copyDir(java.lang.String source, java.lang.String location)
          Copies catalogue into selected place.
 boolean copyFile(java.lang.String source, java.lang.String location)
          Copies file into selected place.
 java.lang.String generateReport(TreeDB db, java.lang.String[] args)
           
 java.lang.String generateReport(TreeDB instTree, java.lang.String template, java.util.Map<java.lang.String,java.lang.Object> data, java.lang.String location)
          Generates report.
protected static void log(java.lang.String mes)
           
static ReportGenerator newInstance()
           
 boolean processTemplate(java.lang.String template, java.util.Map<java.lang.String,java.lang.Object> vars, java.lang.String saveTo)
          processing template.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportGenerator

public ReportGenerator()
Method Detail

newInstance

public static ReportGenerator newInstance()

generateReport

public java.lang.String generateReport(TreeDB db,
                                       java.lang.String[] args)

generateReport

public java.lang.String generateReport(TreeDB instTree,
                                       java.lang.String template,
                                       java.util.Map<java.lang.String,java.lang.Object> data,
                                       java.lang.String location)
                                throws java.io.FileNotFoundException
Generates report.

Parameters:
instTree - root requirement
template - xml mapping file.
data - xml file with additional information for report. Must contains 'object' tags with attributes name and value
location - path to file system catalogue where report should be saved.
Returns:
path to file system catalogue with generated report.
Throws:
java.io.FileNotFoundException - .

copyDir

public boolean copyDir(java.lang.String source,
                       java.lang.String location)
Copies catalogue into selected place.

Parameters:
source - path to catalogue which must be copied.
location - path to where catalogue must be copied.
Returns:
true if coping was successful, false - otherwise.

copyFile

public boolean copyFile(java.lang.String source,
                        java.lang.String location)
Copies file into selected place.

Parameters:
source - path to file which must be copied.
location - path to location where file must be copied.
Returns:
true if coping successful, false - otherwise.

processTemplate

public boolean processTemplate(java.lang.String template,
                               java.util.Map<java.lang.String,java.lang.Object> vars,
                               java.lang.String saveTo)
processing template.

Parameters:
template - path to template.
vars - sequence of template vars.
saveTo - path to location where report is generated.
Returns:
true if generation successful, false - otherwise.

log

protected static void log(java.lang.String mes)