|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectat.tuwien.ifs.somtoolbox.reportgenerator.output.OutputReportLATEX
public class OutputReportLATEX
This class generates the Report as LATEX output. It holds a reference to an instance of ReportFileWriter, to which all Strings that shall appear in the output are send. This class does only handle how this strings schall look like, and not with any technical detail about how these strings are actually written to a file or elsewhere.
Field Summary | |
---|---|
private DatasetInformation |
datasetInformation
|
private String |
outputDirPath
|
private TestRunResultCollection |
testruns
|
private int |
type
|
private ReportFileWriter |
writer
handles the actual writing of the output. |
Constructor Summary | |
---|---|
OutputReportLATEX(String outputDir)
Creates a new Object to finally print the report in LATEX |
Method Summary | |
---|---|
private String |
classNumberString()
returns the information (or missing information) about classes nicely formatted |
void |
createOutput()
creates the report about as HTML file. |
private String |
getSOMDimensions(TestRunResult testrun)
returns the dimension of the SOM nicley formatted. |
private void |
printComparingReport()
creates the sections that compares the results of the different specified trainings this comparison constists of a table containing some basic properties of the SOMs, the visualizations of the class distribution, the distribution of the input items and the U-Matrices of the SOM. |
private void |
printDatasetReport()
outputs the section concerning the dataset Information included in this section are: number of inputs dimension of inputs information about the data distribution within the different dimensions ... Also, if class information are provided, these are printed. |
private void |
printReportEnd()
prints the foot of the report this includes any fixed data to be displayed at the end, as well as all markup required to finish and close the report |
private void |
printReportOnTestrun(int r,
boolean moreRuns)
prints the results of/information about one som training and its results. |
private void |
printReportStart()
prints the head of the report this includes the title and all tags or markup required at the beginning of the report |
private void |
printTestrunsReport()
first outputs the section containing the results from the different teststruns specified, then a short comparison of the testruns (SOM configuration and basic results) is printed. |
void |
setDatasetInformation(DatasetInformation infoObj)
gives an Object to the report writer that stores all information about the used dataset. |
void |
setTestrunInformation(TestRunResultCollection testruns,
int type)
gives an Object to the report writer that stores all information about the performed that shall be documented within the report. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private ReportFileWriter writer
private DatasetInformation datasetInformation
private TestRunResultCollection testruns
private String outputDirPath
private int type
Constructor Detail |
---|
public OutputReportLATEX(String outputDir)
outputDir
- the path to the directory where the files shall be saved toMethod Detail |
---|
public void setDatasetInformation(DatasetInformation infoObj)
setDatasetInformation
in interface OutputReport
infoObj
- object containing all available information about the used datasetpublic void setTestrunInformation(TestRunResultCollection testruns, int type)
setTestrunInformation
in interface OutputReport
testruns
- object containting all available information about the testruns performedpublic void createOutput()
createOutput
in interface OutputReport
private void printReportStart()
private void printReportEnd()
private void printDatasetReport()
private void printTestrunsReport()
private void printReportOnTestrun(int r, boolean moreRuns)
r
- the index of the testrun (start counting by 0)moreRuns
- true if the results of more than one training has been spcified, false otherwiseprivate void printComparingReport()
private String getSOMDimensions(TestRunResult testrun)
testrun
- the testrun for which the dimensions are needed
private String classNumberString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |