Package net.bioclipse.managers

Class ReportManager

java.lang.Object

net.bioclipse.managers.ReportManager

All Implemented Interfaces:

IBactingManager, net.bioclipse.managers.business.IBioclipseManager

public class ReportManager
extends Object
implements IBactingManager

Bioclipse manager providing reporting functionality. Reports are created as IReport which can be serialized as HTML.

Constructor Summary

Constructors

Constructor	Description
ReportManager(String workspaceRoot)	Creates a new ReportManager.

Method Summary

Modifier and Type	Method	Description
String	asHTML(net.bioclipse.report.data.IReport report)	Serializes the content of the given report into HTML.
String	asMarkdown(net.bioclipse.report.data.IReport report)	Serializes the content of the given report into Markdown.
net.bioclipse.report.data.IReport	createReport()	Creates a new IReport object.
List<String>	doi()	Lists the DOIs of the articles associated to this manager.
String	getManagerName()	Gives a short one word name of the manager used as variable name when scripting.

Methods inherited from class java.lang.Object

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

Constructor Details

ReportManager

public ReportManager(String workspaceRoot)

Creates a new ReportManager.

Parameters:

workspaceRoot - location of the workspace, e.g. "."

Method Details

getManagerName

public String getManagerName()

Gives a short one word name of the manager used as variable name when scripting.

Specified by:

getManagerName in interface net.bioclipse.managers.business.IBioclipseManager

createReport

public net.bioclipse.report.data.IReport createReport()

Creates a new IReport object.

Returns:

an empty IReport

asHTML

public String asHTML(net.bioclipse.report.data.IReport report)

Serializes the content of the given report into HTML.

Parameters:

report - an IReport

Returns:

a HTML document as String

asMarkdown

public String asMarkdown(net.bioclipse.report.data.IReport report)

Serializes the content of the given report into Markdown.

Parameters:

report - an IReport

Returns:

a Markdown document as String

doi

public List<String> doi()

Description copied from interface: IBactingManager

Lists the DOIs of the articles associated to this manager.

Specified by:

doi in interface IBactingManager

Returns:

a List of String with DOIs