weka.gui.beans
Class AbstractDataSink

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  weka.gui.beans.AbstractDataSink

All Implemented Interfaces:

javax.accessibility.Accessible, BeanCommon, DataSink, DataSourceListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, TestSetListener, TrainingSetListener, Visible

Direct Known Subclasses:

CSVDataSink

public abstract class AbstractDataSink

extends javax.swing.JPanel

implements DataSink, BeanCommon, Visible, DataSourceListener, TrainingSetListener, TestSetListener, java.io.Serializable

Abstract class for objects that store instances to some destination.

Since:

1.0

Version:

$Revision: 1.3 $

Author:

Mark Hall

See Also:

JPanel, Serializable, Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected java.lang.Object	m_listenee Non null if this object is a target for any events.
protected Logger	m_logger
protected BeanVisual	m_visual Default visual for data sources

Fields inherited from class javax.swing.JPanel

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

AbstractDataSink()

Method Summary

abstract void	acceptDataSet(DataSetEvent e) Accept a data set
void	acceptTestSet(TestSetEvent e) Accept a test set
void	acceptTrainingSet(TrainingSetEvent e) Accept a training set
boolean	connectionAllowed(java.lang.String eventName) Returns true if, at this time, the object will accept a connection according to the supplied event name
void	connectionNotification(java.lang.String eventName, java.lang.Object source) Notify this object that it has been registered as a listener with a source with respect to the supplied event name
void	disconnectionNotification(java.lang.String eventName, java.lang.Object source) Notify this object that it has been deregistered as a listener with a source with respect to the supplied event name
BeanVisual	getVisual() Get the visual being used by this data source.
void	setLog(Logger logger) Set a log for this bean
void	setVisual(BeanVisual newVisual) Set the visual for this data source
abstract void	stop() Stop any processing that the bean might be doing.
void	useDefaultVisual() Use the default images for a data source

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

m_visual

protected BeanVisual m_visual

Default visual for data sources

m_listenee

protected java.lang.Object m_listenee

Non null if this object is a target for any events. Provides for the simplest case when only one incomming connection is allowed. Subclasses can overide the appropriate BeanCommon methods to change this behaviour and allow multiple connections if desired

m_logger

protected transient Logger m_logger

Constructor Detail

AbstractDataSink

public AbstractDataSink()

Method Detail

acceptTrainingSet

public void acceptTrainingSet(TrainingSetEvent e)

Accept a training set

Specified by:

acceptTrainingSet in interface TrainingSetListener

Parameters:

e - a TrainingSetEvent value

acceptTestSet

public void acceptTestSet(TestSetEvent e)

Accept a test set

Specified by:

acceptTestSet in interface TestSetListener

Parameters:

e - a TestSetEvent value

acceptDataSet

public abstract void acceptDataSet(DataSetEvent e)

Accept a data set

Specified by:

acceptDataSet in interface DataSourceListener

Parameters:

e - a DataSetEvent value

setVisual

public void setVisual(BeanVisual newVisual)

Set the visual for this data source

Specified by:

setVisual in interface Visible

Parameters:

newVisual - a BeanVisual value

getVisual

public BeanVisual getVisual()

Get the visual being used by this data source.

Specified by:

getVisual in interface Visible

Returns:

a BeanVisual value

useDefaultVisual

public void useDefaultVisual()

Use the default images for a data source

Specified by:

useDefaultVisual in interface Visible

connectionAllowed

public boolean connectionAllowed(java.lang.String eventName)

Returns true if, at this time, the object will accept a connection according to the supplied event name

Specified by:

connectionAllowed in interface BeanCommon

Parameters:

eventName - the event

Returns:

true if the object will accept a connection

connectionNotification

public void connectionNotification(java.lang.String eventName,
                                   java.lang.Object source)

Notify this object that it has been registered as a listener with a source with respect to the supplied event name

Specified by:

connectionNotification in interface BeanCommon

Parameters:

eventName - the event

source - the source with which this object has been registered as a listener

disconnectionNotification

public void disconnectionNotification(java.lang.String eventName,
                                      java.lang.Object source)

Notify this object that it has been deregistered as a listener with a source with respect to the supplied event name

Specified by:

disconnectionNotification in interface BeanCommon

Parameters:

eventName - the event

source - the source with which this object has been registered as a listener

setLog

public void setLog(Logger logger)

Set a log for this bean

Specified by:

setLog in interface BeanCommon

Parameters:

logger - a weka.gui.Logger value

stop

public abstract void stop()

Stop any processing that the bean might be doing. Subclass must implement

Specified by:

stop in interface BeanCommon