Package org.postgresql.pljava.pgxs

Interface ReportScript

public interface ReportScript

Provides reasonable defaults and other required methods for using JavaScript to during Site lifecycle phase to configure a MavenReport.

Method Summary

Modifier and Type	Method	Description
default boolean	canGenerateReport(ReportScriptingMojo report)
org.apache.maven.reporting.MavenReportException	executeReport(ReportScriptingMojo report, Locale locale)
default String	getCategoryName(ReportScriptingMojo report)
String	getDescription(ReportScriptingMojo report, Locale locale)
String	getName(ReportScriptingMojo report, Locale locale)
String	getOutputName(ReportScriptingMojo report)
default boolean	isExternalReport(ReportScriptingMojo report)

Method Detail

isExternalReport

default boolean isExternalReport(ReportScriptingMojo report)

Parameters:

report - instance of ReportScriptingMojo

Returns:

whether the report is an external report

See Also:

ReportScriptingMojo.isExternalReport()

getCategoryName

default String getCategoryName(ReportScriptingMojo report)

Parameters:

report - instance of ReportScriptingMojo

Returns:

category name of the report

See Also:

ReportScriptingMojo.getCategoryName()

canGenerateReport

default boolean canGenerateReport(ReportScriptingMojo report)

Parameters:

report - instance of ReportScriptingMojo

Returns:

whether the report can be generated

See Also:

ReportScriptingMojo.canGenerateReport()

getOutputName

String getOutputName(ReportScriptingMojo report)

Parameters:

report - instance of ReportScriptingMojo

Returns:

path of the report relative to target site directory

See Also:

ReportScriptingMojo.getCategoryName()

getName

String getName(ReportScriptingMojo report,
               Locale locale)

Parameters:

report - instance of ReportScriptingMojo

locale - preferred locale for the name

Returns:

name of the report

See Also:

ReportScriptingMojo.getName(Locale)

getDescription

String getDescription(ReportScriptingMojo report,
                      Locale locale)

Parameters:

report - instance of ReportScriptingMojo

locale - preferred locale for the description

Returns:

description of the report

See Also:

ReportScriptingMojo.getDescription(Locale)

executeReport

org.apache.maven.reporting.MavenReportException executeReport(ReportScriptingMojo report,
                                                              Locale locale)

Parameters:

report - instance of ReportScriptingMojo

locale - Locale to use for any locale-sensitive content in the report

Returns:

null if execution completed successfully, Exception that occurred during execution otherwise

See Also:

ReportScriptingMojo.executeReport(Locale)