agentgui.core.plugin

Class PlugIn

java.lang.Object

agentgui.core.plugin.PlugIn

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

PlugInError

public abstract class PlugIn
extends java.lang.Object
implements java.util.Observer

This abstract class is the root for customized plug-in's, which can be loaded to extend an individual agent project.
Classes which inherit from this class can be registered to an agent project by using the "Resources"-Tab in the project configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADDED
static java.lang.String	CHANGED
protected java.lang.String	classReference
protected Project	project
static int	REMOVED

Constructor Summary

Constructors

Constructor and Description
PlugIn(Project currProject) Constructor for this class.

Method Summary

Modifier and Type	Method and Description
protected void	addJMenu(javax.swing.JMenu myMenu) This method can be used in order to add an individual menu.
protected void	addJMenu(javax.swing.JMenu myMenu, int indexPosition) This method can be used in order to add an individual menu at a specified index position of the menu bar.
protected void	addJMenuItemComponent(javax.swing.JMenu menu2add, javax.swing.JComponent myMenuItemComponent) This method can be used in order to add an individual JMmenuItem to the given menu.
protected void	addJMenuItemComponent(javax.swing.JMenu menu2add, javax.swing.JComponent myMenuItemComponent, int indexPosition) This method can be used in order to add an individual JMmenuItem at a specified index position of the given menu.
protected void	addJToolbarComponent(javax.swing.JComponent myComponent) This method can be used in order to add an individual menu button to the toolbar.
protected void	addJToolbarComponent(javax.swing.JComponent myComponent, int indexPosition) This method can be used in order to add an individual menu button a specified index position of the toolbar.
protected void	addOntologyClassVisualisation(OntologyClassVisualisation ontologyClassVisualisation) Adds a OntologyClassVisualisation to the global settings.
protected void	addProjectWindowTab(ProjectWindowTab projectWindowTab) This method can be used in order to add a customized Tab to the project window.
protected void	addProjectWindowTab(ProjectWindowTab projectWindowTab, int indexPosition) This method can be used in order to add a customized Tab to the project window at the specified index position.
void	afterPlugOut() This method will be invoked just after the onPlugOut() method was executed.
java.lang.String	getClassReference() Returns the class reference of the current PlugIn.
jade.core.ProfileImpl	getJadeProfile(jade.core.ProfileImpl jadeContainerProfile) Overriding his method allows to extend/change the currently used Profile JADE container.
abstract java.lang.String	getName() Returns the name of the current PlugIn.
boolean	hasValidPreconditionForMasExecution() Checks for valid precondition before the MAS execution.
void	onMasWasTerminated() Will be executed, if the Multi-Agent System was terminated.
void	onMasWillBeExecuted() Will be executed, if the Multi-Agent System is about to start.
void	onPlugIn() This method be called if the plug-in is loaded into the project.
protected void	onPlugInAdded(PlugIn plugIn) On plug in added.
protected void	onPlugInRemoved(PlugIn plugIn) On plug in removed.
void	onPlugOut() This method will be called if the plug-in will be removed from the project, means immediately before the project will be closed.
protected void	onPrepareForSaving() On notification to do the preparations to save a project or simulation setup.
protected void	onProjectChangedAgentStartConfiguration() On project changed agent start configuration.
protected void	onProjectChangedEnvironmentModel() On project changed environment model.
protected void	onProjectChangedJadeConfiguration() On project changed jade configuration.
protected void	onProjectChangedProjectDescription() On project changed project description.
protected void	onProjectChangedProjectName() On project changed project name.
protected void	onProjectChangedProjectOntology() On project changed project ontology.
protected void	onProjectChangedProjectResources() On project changed project resources.
protected void	onProjectChangedProjectView() On project changed project view.
protected void	onProjectChangedTimeModelConfiguration() On project changed TimeModel configuration.
protected void	onProjectSaved(boolean isExcludeSetup) On project saved.
protected void	onSimSetupAddNew(SimulationSetup simSetup) Will be invoked, if a new SimulationSetup was created.
protected void	onSimSetupCopy(SimulationSetup simSetup) Will be invoked, if a SimulationSetup was copied.
protected void	onSimSetupLoad(SimulationSetup simSetup) Will be invoked, if a SimulationSetup was loaded.
protected void	onSimSetupPrepareSaving(SimulationSetup simSetup) Will be invoked, before a SimulationSetup will be saved
protected void	onSimSetupRemove(SimulationSetup simSetup) Will be invoked, if a SimulationSetup was removed.
protected void	onSimSetupRename(SimulationSetup simSetup) Will be invoked, if a SimulationSetup was renamed.
protected void	onSimSetupSaved(SimulationSetup simSetup) Will be invoked, if a SimulationSetup was saved
void	setClassReference(java.lang.String classReference) Sets the class reference of this PugIn.
void	update(java.util.Observable observable, java.lang.Object updateObject) AgentGUI uses the observer pattern to inform about changes within the project.
protected void	updateFromObserver(java.util.Observable observable, java.lang.Object updateObject) In order to perceive individual informations from the Project Observer (observer pattern), this method should be used in the extended class. !!!

Methods inherited from class java.lang.Object

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

Field Detail

CHANGED

public static final java.lang.String CHANGED

See Also:

Constant Field Values

ADDED

public static final int ADDED

See Also:

Constant Field Values

REMOVED

public static final int REMOVED

See Also:

Constant Field Values

project

protected Project project

classReference

protected java.lang.String classReference

Constructor Detail

PlugIn

public PlugIn(Project currProject)

Constructor for this class.

Parameters:

currProject - the current project

Method Detail

setClassReference

public void setClassReference(java.lang.String classReference)

Sets the class reference of this PugIn.

Parameters:

classReference - the classReference to set

getClassReference

public java.lang.String getClassReference()

Returns the class reference of the current PlugIn.

Returns:

the classReference as String

getName

public abstract java.lang.String getName()

Returns the name of the current PlugIn.

Returns:

the pluginName

onPlugIn

public void onPlugIn()

This method be called if the plug-in is loaded into the project. This happens immediately after the project was opened.

onPlugOut

public void onPlugOut()

This method will be called if the plug-in will be removed from the project, means immediately before the project will be closed.

afterPlugOut

public void afterPlugOut()

This method will be invoked just after the onPlugOut() method was executed. DO NOT OVERRIDE !!!

addJMenu

protected void addJMenu(javax.swing.JMenu myMenu)

This method can be used in order to add an individual menu.

Parameters:

myMenu - the my menu

addJMenu

protected void addJMenu(javax.swing.JMenu myMenu,
                        int indexPosition)

This method can be used in order to add an individual menu at a specified index position of the menu bar.

Parameters:

myMenu - the my menu

indexPosition - the index position

addJMenuItemComponent

protected void addJMenuItemComponent(javax.swing.JMenu menu2add,
                                     javax.swing.JComponent myMenuItemComponent)

This method can be used in order to add an individual JMmenuItem to the given menu.

Parameters:

menu2add - the menu2add

myMenuItemComponent - the my menu item component

addJMenuItemComponent

protected void addJMenuItemComponent(javax.swing.JMenu menu2add,
                                     javax.swing.JComponent myMenuItemComponent,
                                     int indexPosition)

This method can be used in order to add an individual JMmenuItem at a specified index position of the given menu.

Parameters:

menu2add - the menu2add

myMenuItemComponent - the my menu item component

indexPosition - the index position

addJToolbarComponent

protected void addJToolbarComponent(javax.swing.JComponent myComponent)

This method can be used in order to add an individual menu button to the toolbar.

Parameters:

myComponent - the my component

addJToolbarComponent

protected void addJToolbarComponent(javax.swing.JComponent myComponent,
                                    int indexPosition)

This method can be used in order to add an individual menu button a specified index position of the toolbar.

Parameters:

myComponent - the my component

indexPosition - the index position

addProjectWindowTab

protected void addProjectWindowTab(ProjectWindowTab projectWindowTab)

This method can be used in order to add a customized Tab to the project window.

Parameters:

projectWindowTab - the project window tab

addProjectWindowTab

protected void addProjectWindowTab(ProjectWindowTab projectWindowTab,
                                   int indexPosition)

This method can be used in order to add a customized Tab to the project window at the specified index position. The index position has to be greater than 1, in order to keep the 'Info'-Tab and the 'Configuration'-Tab at its provided position!

Parameters:

projectWindowTab - the project window tab

indexPosition - the index position (greater one)

addOntologyClassVisualisation

protected void addOntologyClassVisualisation(OntologyClassVisualisation ontologyClassVisualisation)

Adds a OntologyClassVisualisation to the global settings. The idea of such an object is that you are able to mask / visualize a specified class of your Ontology in order to allow a more common or simplified access to its data.

Parameters:

classNameOfOntologyClassVisualisation - the class name of an OntologyClassVisualisation

See Also:

OntologyClassVisualisation, OntologyClassWidget, OntologyClassEditorJPanel, GlobalInfo, GlobalInfo#registerOntologyClassVisualisation(String), GlobalInfo#isRegisteredOntologyClassVisualisation(String), OntologyInstanceViewer

update

public final void update(java.util.Observable observable,
                         java.lang.Object updateObject)

AgentGUI uses the observer pattern to inform about changes within the project. They can consist on the following kinds of notifications

- String Project.SAVED
- String Project.CHANGED_ProjectName
- String Project.CHANGED_ProjectDescription
- String Project.CHANGED_ProjectFolder
- String Project.CHANGED_ProjectView
- String Project.CHANGED_EnvironmentModel
- String Project.CHANGED_AgentReferences
- String Project.CHANGED_ProjectOntology
- String Project.CHANGED_ProjectResources

- String SimulationSetups.CHANGED
Here in Detail, while using the 'SimulationSetupsChangeNotification.getUpdateReason' - method:
=> int SimulationSetups.SIMULATION_SETUP_LOAD
=> int SimulationSetups.SIMULATION_SETUP_ADD_NEW
=> int SimulationSetups.SIMULATION_SETUP_COPY
=> int SimulationSetups.SIMULATION_SETUP_REMOVE
=> int SimulationSetups.SIMULATION_SETUP_RENAME
=> int SimulationSetups.SIMULATION_SETUP_SAVED

- String PlugIn.CHANGED
Here in Detail, while using the 'PlugInNotification.getUpdateReason' - method:
=> int PlugIn.ADDED
=> int PlugIn.REMOVED
Furthermore the instance of the PlugIn can be get by using 'PlugInNotification.getPlugIn()'


Do NOT override this method directly. Use the updateFromObserver()-method instead, in order to get your individual Observer-Changes.

Specified by:

update in interface java.util.Observer

Parameters:

observable - the observable

updateObject - the update object

See Also:

Project, SimulationSetup, CHANGED, ADDED, REMOVED, PlugInNotification

updateFromObserver

protected void updateFromObserver(java.util.Observable observable,
                                  java.lang.Object updateObject)

In order to perceive individual informations from the Project Observer (observer pattern), this method should be used in the extended class. !!! Do NOT override the update method directly !!

Parameters:

observable - the observable

updateObject - the update object

onPrepareForSaving

protected void onPrepareForSaving()

On notification to do the preparations to save a project or simulation setup.

onProjectSaved

protected void onProjectSaved(boolean isExcludeSetup)

On project saved.

Parameters:

isExcludeSetup - indicator that reports, if the setup was excluded from the save operation

onProjectChangedProjectName

protected void onProjectChangedProjectName()

On project changed project name.

onProjectChangedProjectDescription

protected void onProjectChangedProjectDescription()

On project changed project description.

onProjectChangedEnvironmentModel

protected void onProjectChangedEnvironmentModel()

On project changed environment model.

onProjectChangedAgentStartConfiguration

protected void onProjectChangedAgentStartConfiguration()

On project changed agent start configuration.

onProjectChangedTimeModelConfiguration

protected void onProjectChangedTimeModelConfiguration()

On project changed TimeModel configuration.

onProjectChangedProjectResources

protected void onProjectChangedProjectResources()

On project changed project resources.

onProjectChangedJadeConfiguration

protected void onProjectChangedJadeConfiguration()

On project changed jade configuration.

onProjectChangedProjectOntology

protected void onProjectChangedProjectOntology()

On project changed project ontology.

onProjectChangedProjectView

protected void onProjectChangedProjectView()

On project changed project view.

onSimSetupAddNew

protected void onSimSetupAddNew(SimulationSetup simSetup)

Will be invoked, if a new SimulationSetup was created.

Parameters:

simSetup - the new SimulationSetup

onSimSetupCopy

protected void onSimSetupCopy(SimulationSetup simSetup)

Will be invoked, if a SimulationSetup was copied.

Parameters:

simSetup - the copied SimulationSetup

onSimSetupLoad

protected void onSimSetupLoad(SimulationSetup simSetup)

Will be invoked, if a SimulationSetup was loaded.

Parameters:

simSetup - the loaded SimulationSetup

onSimSetupRemove

protected void onSimSetupRemove(SimulationSetup simSetup)

Will be invoked, if a SimulationSetup was removed.

Parameters:

simSetup - the current SimulationSetup

onSimSetupRename

protected void onSimSetupRename(SimulationSetup simSetup)

Will be invoked, if a SimulationSetup was renamed.

Parameters:

simSetup - the current SimulationSetup

onSimSetupPrepareSaving

protected void onSimSetupPrepareSaving(SimulationSetup simSetup)

Will be invoked, before a SimulationSetup will be saved

Parameters:

simSetup - the current SimulationSetup

onSimSetupSaved

protected void onSimSetupSaved(SimulationSetup simSetup)

Will be invoked, if a SimulationSetup was saved

Parameters:

simSetup - the current SimulationSetup

onPlugInRemoved

protected void onPlugInRemoved(PlugIn plugIn)

On plug in removed.

Parameters:

plugIn - the plug in

onPlugInAdded

protected void onPlugInAdded(PlugIn plugIn)

On plug in added.

Parameters:

plugIn - the plug in

getJadeProfile

public jade.core.ProfileImpl getJadeProfile(jade.core.ProfileImpl jadeContainerProfile)

Overriding his method allows to extend/change the currently used Profile JADE container.

Parameters:

jadeContainerProfile - The profile to CHANGE

Returns:

the CHANGED (!) configuration of the JADE Profile

hasValidPreconditionForMasExecution

public boolean hasValidPreconditionForMasExecution()

Checks for valid precondition before the MAS execution.

Returns:

true, if the preconditions are valid

onMasWillBeExecuted

public void onMasWillBeExecuted()

Will be executed, if the Multi-Agent System is about to start.

onMasWasTerminated

public void onMasWasTerminated()

Will be executed, if the Multi-Agent System was terminated.