org.homeunix.thecave.buddi.plugin.builtin.report
Class AverageIncomeExpenseByCategory

java.lang.Object
  org.homeunix.thecave.buddi.plugin.api.PreferenceAccess
      org.homeunix.thecave.buddi.plugin.api.BuddiReportPlugin
          org.homeunix.thecave.buddi.plugin.builtin.report.AverageIncomeExpenseByCategory

All Implemented Interfaces:

MossPlugin

public class AverageIncomeExpenseByCategory
extends BuddiReportPlugin

Built-in plugin. Feel free to use this as an example on how to make report plugins

Author:

wyatt

Field Summary

static long

serialVersionUID

Constructor Summary

AverageIncomeExpenseByCategory()

Method Summary

PluginReportDateRangeChoices	getDateRangeChoice() The type of plugin this should be.
java.lang.String	getDescription() Returns the plugin description.
Version	getMaximumVersion() Returns the maximum program version needed to run this plugin.
Version	getMinimumVersion() Returns the minimum program version needed to run this plugin.
java.lang.String	getName() Returns the plugin name.
HtmlPage	getReport(ImmutableDocument model, MossDocumentFrame callingFrame, java.util.Date startDate, java.util.Date endDate) Returns an in-memory version of the printed page, as an HTML file.
boolean	isPluginActive() Should this plugin be activated? Most people can just put true here; if there is some logic which determines if this is to be shown or not, though, you can add it here.

Methods inherited from class org.homeunix.thecave.buddi.plugin.api.BuddiReportPlugin

getReportGUI

Methods inherited from class org.homeunix.thecave.buddi.plugin.api.PreferenceAccess

getListPreference, getPreference, getSecurePreference, putListPreference, putPreference, putSecurePreference

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AverageIncomeExpenseByCategory

public AverageIncomeExpenseByCategory()

Method Detail

getMaximumVersion

public Version getMaximumVersion()

Description copied from interface: MossPlugin

Returns the maximum program version needed to run this plugin. If this is null, there is no limitation on the program (not recommended unless you can guarantee that the plugin uses no API calls within the program).

Specified by:

getMaximumVersion in interface MossPlugin

Overrides:

getMaximumVersion in class BuddiReportPlugin

Returns:

The Version object containing the maximum version number.

getMinimumVersion

public Version getMinimumVersion()

Description copied from interface: MossPlugin

Returns the minimum program version needed to run this plugin. If this is null, there is no limitation on the program (not recommended unless you can guarantee that the plugin uses no API calls within the program).

Specified by:

getMinimumVersion in interface MossPlugin

Overrides:

getMinimumVersion in class BuddiReportPlugin

Returns:

The Version object containing the minimum version number.

isPluginActive

public boolean isPluginActive()

Description copied from interface: MossPlugin

Should this plugin be activated? Most people can just put true here; if there is some logic which determines if this is to be shown or not, though, you can add it here.

Returns:

getReport

public HtmlPage getReport(ImmutableDocument model,
                          MossDocumentFrame callingFrame,
                          java.util.Date startDate,
                          java.util.Date endDate)

Description copied from class: BuddiReportPlugin

Returns an in-memory version of the printed page, as an HTML file. An HtmlPage object is just a small class containing a string with the HTML text in it, and a map of String to BufferedImage containing all the images referenced in the HTML, by name. See HtmlPage for more information on what is needed.

Specified by:

getReport in class BuddiReportPlugin

startDate - Start of report period

endDate - End of report period

Returns:

getName

public java.lang.String getName()

Description copied from interface: MossPlugin

Returns the plugin name. This may be used in different places, depending on the type of plugin.

Returns:

getDescription

public java.lang.String getDescription()

Description copied from interface: MossPlugin

Returns the plugin description. This may be used in different places, depending on the type of plugin.

Returns:

getDateRangeChoice

public PluginReportDateRangeChoices getDateRangeChoice()

Description copied from class: BuddiReportPlugin

The type of plugin this should be. Can choose between one of the following enum values: INTERVAL, START_ONLY, END_ONLY

Specified by:

getDateRangeChoice in class BuddiReportPlugin

Returns:

A constant enum value which determines how the plugin loader should display this plugin.