Package PamModel

Class PamModuleInfo

java.lang.Object

PamModel.PamModuleInfo

All Implemented Interfaces:

PamDependent

public class PamModuleInfo
extends Object
implements PamDependent

Holds information about available PAMGUARD modules.

Author:

Doug Gillespie

See Also:

• PamModel.createPamModel()
• PamDependency

Constructor Summary

Constructors

Constructor	Description
PamModuleInfo(String className, String description, Class moduleClass)

Method Summary

Modifier and Type	Method	Description
void	addDependency(PamDependency dependancy)
void	addGUICompatabilityFlag(int flag)	Add a GUI compatibility flag.
boolean	availableInMode()	Is this module available in this mode ?
boolean	canCreate()
boolean	canRemove()
PamControlledUnit	create(String unitName)
PamControlledUnit	create(PamConfiguration pamConfiguration, String unitName)
static PamModuleInfo	findModuleInfo(String className)
MenuItemEnabler	getAddMenuEnabler()
int	getAllowedModes()
String	getClassName()
String	getDefaultName()
PamDependency	getDependency()
String	getDependentUserName()
String	getDescription()
int	getGUICompatabilityFlag(int index)	Get the GUI flag at the specified index.
protected String	getHelpPoint()
int	getMaxNumber()
PamModel.PamModuleInfo.AddModuleMenuAction	getMenuAction(Frame parentFrame)
int	getMinNumber()
Class	getModuleClass()
static ArrayList<PamModuleInfo>	getModuleList()
static JMenu	getModulesMenu(Frame parentFrame)
ModulesMenuGroup	getModulesMenuGroup()
String	getNewDefaultName()
int	getNGUIFlags()	Get the number of GUI flags.
int	getNInstances()
static JMenu	getRemoveMenu()
MenuItemEnabler	getRemoveMenuEnabler()
String	getToolTipText()
boolean	hasFixedNumber()
boolean	isCoreModule()	PAMGUARD has a set of modules which are so intertwined with very other module that they don't follow the typical process->outputdatablock->process2->outputdatablock->process3...
boolean	isHidden()	Check whether the module is hidden.
static PamModuleInfo	registerControlledUnit(String className, String description)	registers different controlled units in an ArrayList so that they can be instantiated by the user.
static PamModuleInfo	registerControlledUnit(String className, String description, ClassLoader cl)	registers different controlled units in an ArrayList so that they can be instantiated by the user.
void	setAllowedModes(int allowedModes)
void	setCoreModule(boolean coreModule)	PAMGUARD has a set of modules which are so intertwined with very other module that they don't follow the typical process->output data block->process2->output data block->process3...
void	setDefaultName(String defaultName)
protected void	setHelpPoint(String helpPoint)
void	setHidden(boolean hidden)	Hide the module.
void	setMaxNumber(int maxNumber)	Set the maximum number of instances of a given module.
void	setMinNumber(int minNumber)	Set the minumnum number of instances of a particular module.
void	setModulesMenuGroup(ModulesMenuGroup modulesMenuGroup)
void	setToolTipText(String toolTipText)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PamModuleInfo

public PamModuleInfo(String className,
 String description,
 Class moduleClass)

Method Details

getToolTipText

public String getToolTipText()

Returns:

the toolTipText

setToolTipText

public void setToolTipText(String toolTipText)

Parameters:

toolTipText - the toolTipText to set

registerControlledUnit

public static PamModuleInfo registerControlledUnit(String className,
 String description)

registers different controlled units in an ArrayList so that they can be instantiated by the user. Modified to call registerControlledUnit(String, String, ClassLoader) using the default class loader.

Parameters:

className - name of JAVA class.

description - Description of module

Returns:

PamModuleInfo object of the control class

registerControlledUnit

public static PamModuleInfo registerControlledUnit(String className,
 String description,
 ClassLoader cl)

registers different controlled units in an ArrayList so that they can be instantiated by the user.

Parameters:

className - name of JAVA class.

description - Description of module

cl - classloader to use for the JAVA class

Returns:

PamModuleInfo object of the JAVA class

toString

public String toString()

Overrides:

toString in class Object

findModuleInfo

public static PamModuleInfo findModuleInfo(String className)

getMenuAction

public PamModel.PamModuleInfo.AddModuleMenuAction getMenuAction(Frame parentFrame)

create

public PamControlledUnit create(String unitName)

create

public PamControlledUnit create(PamConfiguration pamConfiguration,
 String unitName)

getModuleList

public static ArrayList<PamModuleInfo> getModuleList()

getClassName

public String getClassName()

getDescription

public String getDescription()

getModuleClass

public Class getModuleClass()

getModulesMenu

public static JMenu getModulesMenu(Frame parentFrame)

getRemoveMenu

public static JMenu getRemoveMenu()

isCoreModule

public boolean isCoreModule()

PAMGUARD has a set of modules which are so intertwined with very other module that they don't follow the typical process->outputdatablock->process2->outputdatablock->process3... pattern. These are termed core modules

Note to developer: The meaning of core has changed as of 14/02/2014. Previously referred to supported modules by the PAMGUARD project.

Returns:

true if a core module

setCoreModule

public void setCoreModule(boolean coreModule)

PAMGUARD has a set of modules which are so intertwined with very other module that they don't follow the typical process->output data block->process2->output data block->process3... pattern. These are termed core modules

Note to developer: The meaning of core has changed as of 14/02/2014. Previously referred to supported modules by the PAMGUARD project.

Parameters:

coreModule - true if a core module.

getMaxNumber

public int getMaxNumber()

Returns:

Returns the maxNumber.

setMaxNumber

public void setMaxNumber(int maxNumber)

Set the maximum number of instances of a given module.

Parameters:

maxNumber - The maxNumber to set.

getMinNumber

public int getMinNumber()

Returns:

Returns the minNumber.

setMinNumber

public void setMinNumber(int minNumber)

Set the minumnum number of instances of a particular module.

Parameters:

minNumber - The minNumber to set.

hasFixedNumber

public boolean hasFixedNumber()

canCreate

public boolean canCreate()

canRemove

public boolean canRemove()

addDependency

public void addDependency(PamDependency dependancy)

Specified by:

addDependency in interface PamDependent

getDependency

public PamDependency getDependency()

Specified by:

getDependency in interface PamDependent

getDependentUserName

public String getDependentUserName()

Specified by:

getDependentUserName in interface PamDependent

getNInstances

public int getNInstances()

Returns:

Returns the nInstances.

getDefaultName

public String getDefaultName()

Returns:

Returns the defaultName.

getNewDefaultName

public String getNewDefaultName()

setDefaultName

public void setDefaultName(String defaultName)

Parameters:

defaultName - The defaultName to set.

getAddMenuEnabler

public MenuItemEnabler getAddMenuEnabler()

Returns:

Returns the addMenuEnabler.

getRemoveMenuEnabler

public MenuItemEnabler getRemoveMenuEnabler()

Returns:

Returns the removeMenuEnabler.

getModulesMenuGroup

public ModulesMenuGroup getModulesMenuGroup()

setModulesMenuGroup

public void setModulesMenuGroup(ModulesMenuGroup modulesMenuGroup)

setHidden

public void setHidden(boolean hidden)

Hide the module. The module will still be available if already in a configuration, but will not appear in the add modules menus.

Parameters:

hidden - true if hidden.

isHidden

public boolean isHidden()

Check whether the module is hidden. Hidden modules will still be available if already in a configuration, but will not appear in the add modules menus.

Returns:

true if hidden.

addGUICompatabilityFlag

public void addGUICompatabilityFlag(int flag)

Add a GUI compatibility flag. These are flags in PAMGuiManager e.g. PAMGUIManager.swing

Parameters:

the - GUI flag.

getNGUIFlags

public int getNGUIFlags()

Get the number of GUI flags. These defined which GUI's the Module is compatible with.

Returns:

the number of GUI flags.

getGUICompatabilityFlag

public int getGUICompatabilityFlag(int index)

Get the GUI flag at the specified index.

Parameters:

the - index.

getHelpPoint

protected String getHelpPoint()

Returns:

the helpPoint

setHelpPoint

protected void setHelpPoint(String helpPoint)

Parameters:

helpPoint - the helpPoint to set

getAllowedModes

public int getAllowedModes()

Returns:

the allowedModes

setAllowedModes

public void setAllowedModes(int allowedModes)

Parameters:

allowedModes - the allowedModes to set

availableInMode

public boolean availableInMode()

Is this module available in this mode ?

Returns:

true if available.