Package org.aavso.tools.vstar.plugin

Class ModelCreatorPluginBase

java.lang.Object

org.aavso.tools.vstar.plugin.ModelCreatorPluginBase

All Implemented Interfaces:

IPlugin

Direct Known Subclasses:

ApacheCommonsPolynomialFitCreatorPlugin

public abstract class ModelCreatorPluginBase
extends Object
implements IPlugin

This is the abstract base class for all model creator plugin classes.

A model creator plugin will appear in VStar's Analysis menu when its jar file is placed into the vstar_plugins directory.

See Also:

• IPlugin

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	testMode

Constructor Summary

Constructors

Constructor	Description
ModelCreatorPluginBase()

Method Summary

Modifier and Type	Method	Description
boolean	additionalAuthenticationSatisfied(LoginInfo loginInfo)	This method will be called after requiresAuthentication() in case any additional authentication is required.
abstract String	getDescription()	Get a description of this plugin.
abstract String	getDisplayName()	Get the human-readable display name for this plugin, e.g.
String	getDocName()	Get a document file name for this plugin.
String	getGroup()	Get the group to which this plugin belongs (may be null).
abstract IModel	getModel(List<ValidObservation> obs)	Returns the model object for this plugin whose execute() method can be invoked to create the model artifacts.
boolean	inTestMode()	Is the current invocation of the plug-in in test mode? This can help in design-for-test by allowing non-essential logic to change what code is invoked during a test.
boolean	requiresAuthentication()	Does this plugin require authentication?
void	setParams(Object[] params)	Set parameters for this model creator plugin invocation.
void	setTestMode(boolean mode)	Set the test mode.
Boolean	test()	Method to be invoked in order to test this plug-in

Methods inherited from class java.lang.Object

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

Field Details

testMode

protected boolean testMode

Constructor Details

ModelCreatorPluginBase

public ModelCreatorPluginBase()

Method Details

getModel

public abstract IModel getModel(List<ValidObservation> obs)

Returns the model object for this plugin whose execute() method can be invoked to create the model artifacts.

Parameters:

obs - The list of observations to create a model of.

Returns:

The model object or null if no model was created.

getDescription

public abstract String getDescription()

Description copied from interface: IPlugin

Get a description of this plugin.

Specified by:

getDescription in interface IPlugin

See Also:

• IPlugin.getDescription()

getDisplayName

public abstract String getDisplayName()

Description copied from interface: IPlugin

Get the human-readable display name for this plugin, e.g. for a period analysis menu item.

Specified by:

getDisplayName in interface IPlugin

See Also:

• IPlugin.getDisplayName()

getDocName

public String getDocName()

Description copied from interface: IPlugin

Get a document file name for this plugin. Can be a full (absolute) URL or a file name that assumes the plugin doc directory as a base URL.

Specified by:

getDocName in interface IPlugin

See Also:

• IPlugin.getDocName()

setParams

public void setParams(Object[] params)

Set parameters for this model creator plugin invocation.

Parameters:

params - The parameters to set.

getGroup

public String getGroup()

Description copied from interface: IPlugin

Get the group to which this plugin belongs (may be null).

Specified by:

getGroup in interface IPlugin

See Also:

• IPlugin.getGroup()

requiresAuthentication

public boolean requiresAuthentication()

Description copied from interface: IPlugin

Does this plugin require authentication?

Specified by:

requiresAuthentication in interface IPlugin

Returns:

Whether or not the plugin requires authentication.

See Also:

• IPlugin.requiresAuthentication()

additionalAuthenticationSatisfied

public boolean additionalAuthenticationSatisfied(LoginInfo loginInfo)

Description copied from interface: IPlugin

This method will be called after requiresAuthentication() in case any additional authentication is required.

Specified by:

additionalAuthenticationSatisfied in interface IPlugin

Parameters:

loginInfo - The current session's login information.

Returns:

Whether or not any additional authentication has satisfied.

See Also:

• IPlugin.additionalAuthenticationSatisfied(org.aavso.tools.vstar.ui.resources.LoginInfo)

test

public Boolean test()

Description copied from interface: IPlugin

Method to be invoked in order to test this plug-in

Specified by:

test in interface IPlugin

Returns:

whether the test passed (true, false) or null meaning no test

inTestMode

public boolean inTestMode()

Description copied from interface: IPlugin

Is the current invocation of the plug-in in test mode? This can help in design-for-test by allowing non-essential logic to change what code is invoked during a test.

Specified by:

inTestMode in interface IPlugin

Returns:

true or false

setTestMode

public void setTestMode(boolean mode)

Description copied from interface: IPlugin

Set the test mode. Each test() method must do this if required, and not all plug-in tests will require it.

Specified by:

setTestMode in interface IPlugin

Parameters:

mode - true or false, denoting whether in test mode