weka.gui.beans
Class BeanConnection

java.lang.Object
  weka.gui.beans.BeanConnection

All Implemented Interfaces:

java.io.Serializable

public class BeanConnection

extends java.lang.Object

implements java.io.Serializable

Class for encapsulating a connection between two beans. Also maintains a list of all connections

Version:

$Revision: 1.2 $

Author:

Mark Hall

See Also:

Serialized Form

Field Summary

static java.util.Vector	CONNECTIONS The list of connections
private java.lang.String	m_eventName The name of the event for this connection
private BeanInstance	m_source
private BeanInstance	m_target

Constructor Summary

BeanConnection(BeanInstance source, BeanInstance target, java.beans.EventSetDescriptor esd)
Creates a new BeanConnection instance.

Method Summary

static java.util.Vector	getClosestConnections(java.awt.Point pt, int delta) Return a list of connections within some delta of a point
static java.util.Vector	getConnections() Returns the list of connections
protected BeanInstance	getSource() returns the source BeanInstance for this connection
protected java.beans.EventSetDescriptor	getSourceEventSetDescriptor() Returns the event set descriptor for the event generated by the source for this connection
protected BeanInstance	getTarget() Returns the target BeanInstance for this connection
static void	paintConnections(java.awt.Graphics gx) Renders the connections and their names on the supplied graphics context
private static boolean	previousLink(BeanInstance source, BeanInstance target, int index) Returns true if there is a link between the supplied source and target BeanInstances at an earlier index than the supplied index
void	remove() Remove this connection
static void	removeConnections(BeanInstance instance) Remove all connections for a bean.
static void	reset() Reset the list of connections
static void	setConnections(java.util.Vector connections) Describe setConnections method here.

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTIONS

public static java.util.Vector CONNECTIONS

The list of connections

m_source

private BeanInstance m_source

m_target

private BeanInstance m_target

m_eventName

private java.lang.String m_eventName

The name of the event for this connection

Constructor Detail

BeanConnection

public BeanConnection(BeanInstance source,
                      BeanInstance target,
                      java.beans.EventSetDescriptor esd)

Creates a new BeanConnection instance.

Parameters:

source - the source bean

target - the target bean

esd - the EventSetDescriptor for the connection

Method Detail

reset

public static void reset()

Reset the list of connections

getConnections

public static java.util.Vector getConnections()

Returns the list of connections

Returns:

the list of connections

setConnections

public static void setConnections(java.util.Vector connections)

Describe setConnections method here.

Parameters:

connections - a Vector value

previousLink

private static boolean previousLink(BeanInstance source,
                                    BeanInstance target,
                                    int index)

Returns true if there is a link between the supplied source and target BeanInstances at an earlier index than the supplied index

Parameters:

source - the source BeanInstance

target - the target BeanInstance

index - the index to compare to

Returns:

true if there is already a link at an earlier index

paintConnections

public static void paintConnections(java.awt.Graphics gx)

Renders the connections and their names on the supplied graphics context

Parameters:

gx - a Graphics value

getClosestConnections

public static java.util.Vector getClosestConnections(java.awt.Point pt,
                                                     int delta)

Return a list of connections within some delta of a point

Parameters:

pt - the point at which to look for connections

delta - connections have to be within this delta of the point

Returns:

a list of connections

removeConnections

public static void removeConnections(BeanInstance instance)

Remove all connections for a bean. If the bean is a target for receiving events then it gets deregistered from the corresonding source bean. If the bean is a source of events then all targets implementing BeanCommon are notified via their disconnectionNotification methods that the source (and hence the connection) is going away.

Parameters:

instance - the bean to remove connections to/from

remove

public void remove()

Remove this connection

getSource

protected BeanInstance getSource()

returns the source BeanInstance for this connection

Returns:

a BeanInstance value

getTarget

protected BeanInstance getTarget()

Returns the target BeanInstance for this connection

Returns:

a BeanInstance value

getSourceEventSetDescriptor

protected java.beans.EventSetDescriptor getSourceEventSetDescriptor()

Returns the event set descriptor for the event generated by the source for this connection

Returns:

an EventSetDescriptor value