PamModel

Class PamModuleInfo

java.lang.Object

PamModel.PamModuleInfo

All Implemented Interfaces:

PamDependent

public class PamModuleInfo
extends java.lang.Object
implements PamDependent

Holds information about available PAMGUARD modules.

Author:

Doug Gillespie

See Also:

PamModel.createPamModel(), PamDependency

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(PamDependency dependancy)
boolean	canCreate()
boolean	canRemove()
PamControlledUnit	create(java.lang.String unitName)
static PamModuleInfo	findModuleInfo(java.lang.String className)
MenuItemEnabler	getAddMenuEnabler()
java.lang.String	getClassName()
java.lang.String	getDefaultName()
PamDependency	getDependency()
java.lang.String	getDependentUserName()
java.lang.String	getDescription()
int	getMaxNumber()
PamModel.PamModuleInfo.AddModuleMenuAction	getMenuAction(java.awt.Frame parentFrame)
int	getMinNumber()
java.lang.Class	getModuleClass()
static java.util.ArrayList<PamModuleInfo>	getModuleList()
static javax.swing.JMenu	getModulesMenu(java.awt.Frame parentFrame)
ModulesMenuGroup	getModulesMenuGroup()
java.lang.String	getNewDefaultName()
int	getNInstances()
static javax.swing.JMenu	getRemoveMenu()
MenuItemEnabler	getRemoveMenuEnabler()
java.lang.String	getToolTipText()
boolean	hasFixedNumber()
boolean	isCoreModule()
boolean	isHidden()
static PamModuleInfo	registerControlledUnit(java.lang.String className, java.lang.String description) registers different controlled units in an ArrayList so that they can be instantiated by the user.
void	setCoreModule(boolean coreModule)
void	setDefaultName(java.lang.String defaultName)
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(java.lang.String toolTipText)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getToolTipText

public java.lang.String getToolTipText()

Returns:

the toolTipText

setToolTipText

public void setToolTipText(java.lang.String toolTipText)

Parameters:

toolTipText - the toolTipText to set

registerControlledUnit

public static PamModuleInfo registerControlledUnit(java.lang.String className,
                                   java.lang.String description)

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

Returns:

true if OK

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

findModuleInfo

public static PamModuleInfo findModuleInfo(java.lang.String className)

getMenuAction

public PamModel.PamModuleInfo.AddModuleMenuAction getMenuAction(java.awt.Frame parentFrame)

create

public PamControlledUnit create(java.lang.String unitName)

getModuleList

public static java.util.ArrayList<PamModuleInfo> getModuleList()

getClassName

public java.lang.String getClassName()

getDescription

public java.lang.String getDescription()

getModuleClass

public java.lang.Class getModuleClass()

getModulesMenu

public static javax.swing.JMenu getModulesMenu(java.awt.Frame parentFrame)

getRemoveMenu

public static javax.swing.JMenu getRemoveMenu()

isCoreModule

public boolean isCoreModule()

setCoreModule

public void setCoreModule(boolean coreModule)

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 java.lang.String getDependentUserName()

Specified by:

getDependentUserName in interface PamDependent

getNInstances

public int getNInstances()

Returns:

Returns the nInstances.

getDefaultName

public java.lang.String getDefaultName()

Returns:

Returns the defaultName.

getNewDefaultName

public java.lang.String getNewDefaultName()

setDefaultName

public void setDefaultName(java.lang.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 -

isHidden

public boolean isHidden()

Returns:

the hidden