owltools.ontologyrelease.reports
Interface OntologyReportGenerator.OntologyReport

All Known Implementing Classes:
External2GoReports.External2GoKegg, External2GoReports.External2GoMetaCyc, External2GoReports.External2GoReactome, External2GoReports.External2GoResid, External2GoReports.External2GoRhea, External2GoReports.External2GoUmBbdEnzymeId, External2GoReports.External2GoUmBbdPathwayId, External2GoReports.External2GoUmBbdReactionId, External2GoReports.External2GoWikipedia, OBOTermsAltIdsReport, OBOTermsIdsObsoleteReport, OBOTermsIdsReport, ObsoletesAllReport, ObsoletesExactReport, ObsoletesInExactReport, OntologyReportGenerator.AbstractReport
Enclosing class:
OntologyReportGenerator

public static interface OntologyReportGenerator.OntologyReport

Ontology report to be run with the OntologyReportGenerator.


Method Summary
 void end(PrintWriter writer, OWLGraphWrapper graph)
          End the report.
 String getReportFileName()
          Get the target file name for this report.
 String getReportSubFolderName()
          Get the sub folder name for the report
 void handleTerm(PrintWriter writer, org.semanticweb.owlapi.model.OWLClass owlClass, OWLGraphWrapper graph)
          Handle an OWLObject during the report.
 void start(PrintWriter writer, OWLGraphWrapper graph)
          Start the report.
 

Method Detail

getReportSubFolderName

String getReportSubFolderName()
Get the sub folder name for the report

Returns:
subFolder name or null

getReportFileName

String getReportFileName()
Get the target file name for this report.

Returns:
fileName

start

void start(PrintWriter writer,
           OWLGraphWrapper graph)
           throws IOException
Start the report.

Parameters:
writer -
graph -
Throws:
IOException

handleTerm

void handleTerm(PrintWriter writer,
                org.semanticweb.owlapi.model.OWLClass owlClass,
                OWLGraphWrapper graph)
                throws IOException
Handle an OWLObject during the report.

Parameters:
writer -
owlClass -
graph -
Throws:
IOException

end

void end(PrintWriter writer,
         OWLGraphWrapper graph)
         throws IOException
End the report.

Parameters:
writer -
graph -
Throws:
IOException


Copyright © 2010-2012. All Rights Reserved.