org.systemsbiology.gaggle.core
Interface Goose

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

AnnotationGoose, ClusterViewer, ControlPanel, ControlPanel, ControlPanel, ControlPanel, ControlPanel, ControlPanel, CyGagglePlugin, DiagGoose, EchoGoose, EnrichmentGraphPlugin, GaggledLister, GaggledMev, GaggledTreeDataViewer, IHopGoose, MasterMapPlugin, NameGoose, RegexFilterGoose, RShellGoose, SampleGoose, SequenceGoose

public interface Goose
extends java.rmi.Remote

The core client interface for the Gaggle - any software which needs to communicate with the gaggle must implement this interface. Implementations of Goose are desgined to be compiled by rmic into stubs which can communicate across JVMs. Hence every method must throw RemoteException.

See Also:

for a "canonical" implementation

Method Summary

void	doBroadcastList() Deprecated. This is no longer used.
void	doExit() Tells the goose to exit (terminate).
void	doHide() Tells the goose to hide itself
void	doShow() Tells the goose to show itself
java.lang.String	getName() Returns the name of the goose.
void	handleCluster(java.lang.String source, Cluster cluster) Called when the goose receives a Cluster object
void	handleMatrix(java.lang.String source, DataMatrix matrix) Called when the goose receives a DataMatrix object
void	handleNameList(java.lang.String source, Namelist nameList) Called when the goose receives a NameList object
void	handleNetwork(java.lang.String source, Network network) Called when the goose receives a Network object
void	handleTuple(java.lang.String source, GaggleTuple gaggleTuple) Called when the goose receives a GaggleTuple object
void	setName(java.lang.String newName) Sets the name of (renames) the goose.
void	update(java.lang.String[] gooseNames) Provides the goose with an updated list of the names of active geese.

Method Detail

handleNameList

void handleNameList(java.lang.String source,
                    Namelist nameList)
                    throws java.rmi.RemoteException

Called when the goose receives a NameList object

Parameters:

source - Optional string indicating name of source goose

nameList - The NameList object

Throws:

java.rmi.RemoteException - if RMI communication fails

handleMatrix

void handleMatrix(java.lang.String source,
                  DataMatrix matrix)
                  throws java.rmi.RemoteException

Called when the goose receives a DataMatrix object

Parameters:

source - Optional string indicating name of source goose

matrix - The DataMatrix object

Throws:

java.rmi.RemoteException - if RMI communication fails

handleTuple

void handleTuple(java.lang.String source,
                 GaggleTuple gaggleTuple)
                 throws java.rmi.RemoteException

Called when the goose receives a GaggleTuple object

Parameters:

source - Optional string indicating name of source goose

gaggleTuple - The GaggleTuple object

Throws:

java.rmi.RemoteException - if RMI communication fails

handleCluster

void handleCluster(java.lang.String source,
                   Cluster cluster)
                   throws java.rmi.RemoteException

Called when the goose receives a Cluster object

Parameters:

source - Optional string indicating name of source goose

cluster - The Cluster object

Throws:

java.rmi.RemoteException - if RMI communication fails

handleNetwork

void handleNetwork(java.lang.String source,
                   Network network)
                   throws java.rmi.RemoteException

Called when the goose receives a Network object

Parameters:

source - Optional string indicating name of source goose

network - The Network object

Throws:

java.rmi.RemoteException - if RMI communication fails

update

void update(java.lang.String[] gooseNames)
            throws java.rmi.RemoteException

Provides the goose with an updated list of the names of active geese. This list includes the name of the goose receiving the list.

Parameters:

gooseNames - the names of the currently active geese

Throws:

java.rmi.RemoteException - if RMI communication fails

See Also:

MiscUtil.updateGooseChooser(javax.swing.JComboBox gooseChooser, String callingGoose, String[] allGeese);

getName

java.lang.String getName()
                         throws java.rmi.RemoteException

Returns the name of the goose.

Returns:

the name of the goose

Throws:

java.rmi.RemoteException - if RMI communication fails

setName

void setName(java.lang.String newName)
             throws java.rmi.RemoteException

Sets the name of (renames) the goose.

Parameters:

newName - The new name of the goose

Throws:

java.rmi.RemoteException - if RMI communication fails

doBroadcastList

void doBroadcastList()
                     throws java.rmi.RemoteException

Deprecated. This is no longer used.

Throws:

java.rmi.RemoteException - if RMI communication fails

doHide

void doHide()
            throws java.rmi.RemoteException

Tells the goose to hide itself

Throws:

java.rmi.RemoteException - if RMI communication fails

doShow

void doShow()
            throws java.rmi.RemoteException

Tells the goose to show itself

Throws:

java.rmi.RemoteException - if RMI communication fails

doExit

void doExit()
            throws java.rmi.RemoteException

Tells the goose to exit (terminate).

Throws:

java.rmi.RemoteException - if RMI communication fails