cfa.vo.iris.sdk
Class AbstractIrisComponent

java.lang.Object
  cfa.vo.iris.sdk.AbstractIrisComponent

All Implemented Interfaces:

IrisComponent

Direct Known Subclasses:

PluginManager

public abstract class AbstractIrisComponent
extends Object
implements IrisComponent

Author:

olaurino

Field Summary

protected IrisApplication	app
protected IWorkspace	workspace

Constructor Summary

AbstractIrisComponent()

Method Summary

ICommandLineInterface	getCli() Get a command line interface object for this component.
List<org.astrogrid.samp.client.MessageHandler>	getSampHandlers() The component can register any number of SAMP message listeners by providing a list of them.
void	init(IrisApplication app, IWorkspace workspace) This method is invoked to initialize the component.
void	initCli(IrisApplication app) Initialize the Command Line Application interface
void	shutdown() Callback invoked when the component is shutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface cfa.vo.iris.IrisComponent

getDescription, getMenus, getName

Field Detail

app

protected IrisApplication app

workspace

protected IWorkspace workspace

Constructor Detail

AbstractIrisComponent

public AbstractIrisComponent()

Method Detail

init

public void init(IrisApplication app,
                 IWorkspace workspace)

Description copied from interface: IrisComponent

This method is invoked to initialize the component. If the component has to launch windows, frames or background services, this is the right method to do so. Otherwise the component will be called only if a callback is invoked.

Specified by:

init in interface IrisComponent

Parameters:

app - A reference to the running application

workspace - A reference to the application's workspace

getCli

public ICommandLineInterface getCli()

Description copied from interface: IrisComponent

Get a command line interface object for this component.

Specified by:

getCli in interface IrisComponent

Returns:

A CLI object

initCli

public void initCli(IrisApplication app)

Description copied from interface: IrisComponent

Initialize the Command Line Application interface

Specified by:

initCli in interface IrisComponent

Parameters:

app - Reference to the enclosing application

getSampHandlers

public List<org.astrogrid.samp.client.MessageHandler> getSampHandlers()

Description copied from interface: IrisComponent

The component can register any number of SAMP message listeners by providing a list of them.

Specified by:

getSampHandlers in interface IrisComponent

Returns:

A list of the SAMP message listeners that have to be registered to the SAMP hub.

shutdown

public void shutdown()

Description copied from interface: IrisComponent

Callback invoked when the component is shutdown

Specified by:

shutdown in interface IrisComponent