weka.gui.beans
Class Appender

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by weka.gui.beans.Appender
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, BeanCommon, DataSource, DataSourceListener, EventConstraints, InstanceListener, TestSetListener, TrainingSetListener, Visible

@KFStep(category="Tools",
        toolTipText="Append multiple sets of instances")
public class Appender
extends JPanel
implements BeanCommon, Visible, Serializable, DataSource, DataSourceListener, TrainingSetListener, TestSetListener, InstanceListener, EventConstraints

A bean that appends multiple incoming data connections into a single data set. The incoming connections can be either all instance connections or all batch-oriented connections (i.e. data set, training set and test set). Instance and batch connections can't be mixed. An amalgamated output is created that is a combination of all the incoming attributes. Missing values are used to fill columns that don't exist in a particular incoming data set. If all incoming connections are instance connections, then the outgoing connection must be an instance connection (and vice versa for incoming batch connections).

Version:
$Revision: 8034 $
Author:
Mark Hall (mhall{[at]}pentaho{[dot]}com)
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
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
Appender()
          Constructs a new Appender.
 
Method Summary
 void acceptDataSet(DataSetEvent e)
          Accept and process a data set event
 void acceptInstance(InstanceEvent e)
          Accept and process an instance event
 void acceptTestSet(TestSetEvent e)
          Accept and process a test set event
 void acceptTrainingSet(TrainingSetEvent e)
          Accept and process a training set event
 void addDataSourceListener(DataSourceListener dsl)
          Add a data source listener
 void addInstanceListener(InstanceListener tsl)
          Add an instance listener
 boolean connectionAllowed(EventSetDescriptor esd)
          Returns true if, at this time, the object will accept a connection via the named event
 boolean connectionAllowed(String eventName)
          Returns true if, at this time, the object will accept a connection via the named event
 void connectionNotification(String eventName, Object source)
          Notify this object that it has been registered as a listener with a source for recieving events described by the named event This object is responsible for recording this fact.
 void disconnectionNotification(String eventName, Object source)
          Notify this object that it has been deregistered as a listener with a source for named event.
 boolean eventGeneratable(String eventName)
          Returns true if, at the current time, the named event could be generated.
 String getCustomName()
          Get the custom (descriptive) name for this bean (if one has been set)
 BeanVisual getVisual()
          Get the visual representation
 boolean isBusy()
          Returns true if.
 void removeDataSourceListener(DataSourceListener dsl)
          Remove a data source listener
 void removeInstanceListener(InstanceListener tsl)
          Remove an instance listener
 void setCustomName(String name)
          Set a custom (descriptive) name for this bean
 void setLog(Logger logger)
          Set a logger
 void setVisual(BeanVisual newVisual)
          Set a new visual representation
 void stop()
          Stop any processing that the bean might be doing.
 void useDefaultVisual()
          Use the default visual representation
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Appender

public Appender()
Constructs a new Appender.

Method Detail

eventGeneratable

public boolean eventGeneratable(String eventName)
Returns true if, at the current time, the named event could be generated.

Specified by:
eventGeneratable in interface EventConstraints
Parameters:
eventName - the name of the event in question
Returns:
true if the named event could be generated

acceptInstance

public void acceptInstance(InstanceEvent e)
Accept and process an instance event

Specified by:
acceptInstance in interface InstanceListener
Parameters:
e - an InstanceEvent value

acceptTestSet

public void acceptTestSet(TestSetEvent e)
Accept and process a test set event

Specified by:
acceptTestSet in interface TestSetListener
Parameters:
e - a TestSetEvent value

acceptTrainingSet

public void acceptTrainingSet(TrainingSetEvent e)
Accept and process a training set event

Specified by:
acceptTrainingSet in interface TrainingSetListener
Parameters:
e - a TrainingSetEvent value

acceptDataSet

public void acceptDataSet(DataSetEvent e)
Accept and process a data set event

Specified by:
acceptDataSet in interface DataSourceListener
Parameters:
e - a DataSetEvent value

addDataSourceListener

public void addDataSourceListener(DataSourceListener dsl)
Add a data source listener

Specified by:
addDataSourceListener in interface DataSource
Parameters:
dsl - a DataSourceListener value

removeDataSourceListener

public void removeDataSourceListener(DataSourceListener dsl)
Remove a data source listener

Specified by:
removeDataSourceListener in interface DataSource
Parameters:
dsl - a DataSourceListener value

addInstanceListener

public void addInstanceListener(InstanceListener tsl)
Add an instance listener

Specified by:
addInstanceListener in interface DataSource
Parameters:
tsl - an InstanceListener value

removeInstanceListener

public void removeInstanceListener(InstanceListener tsl)
Remove an instance listener

Specified by:
removeInstanceListener in interface DataSource
Parameters:
tsl - an InstanceListener value

useDefaultVisual

public void useDefaultVisual()
Use the default visual representation

Specified by:
useDefaultVisual in interface Visible

setVisual

public void setVisual(BeanVisual newVisual)
Set a new visual representation

Specified by:
setVisual in interface Visible
Parameters:
newVisual - a BeanVisual value

getVisual

public BeanVisual getVisual()
Get the visual representation

Specified by:
getVisual in interface Visible
Returns:
a BeanVisual value

setCustomName

public void setCustomName(String name)
Set a custom (descriptive) name for this bean

Specified by:
setCustomName in interface BeanCommon
Parameters:
name - the name to use

getCustomName

public String getCustomName()
Get the custom (descriptive) name for this bean (if one has been set)

Specified by:
getCustomName in interface BeanCommon
Returns:
the custom name (or the default name)

stop

public void stop()
Stop any processing that the bean might be doing.

Specified by:
stop in interface BeanCommon

isBusy

public boolean isBusy()
Returns true if. at this time, the bean is busy with some (i.e. perhaps a worker thread is performing some calculation).

Specified by:
isBusy in interface BeanCommon
Returns:
true if the bean is busy.

setLog

public void setLog(Logger logger)
Set a logger

Specified by:
setLog in interface BeanCommon
Parameters:
logger - a weka.gui.Logger value

connectionAllowed

public boolean connectionAllowed(EventSetDescriptor esd)
Returns true if, at this time, the object will accept a connection via the named event

Specified by:
connectionAllowed in interface BeanCommon
Parameters:
esd - the EventSetDescriptor for the event in question
Returns:
true if the object will accept a connection

connectionAllowed

public boolean connectionAllowed(String eventName)
Returns true if, at this time, the object will accept a connection via the named event

Specified by:
connectionAllowed in interface BeanCommon
Parameters:
eventName - the name of the event
Returns:
true if the object will accept a connection

connectionNotification

public void connectionNotification(String eventName,
                                   Object source)
Notify this object that it has been registered as a listener with a source for recieving events described by the named event This object is responsible for recording this fact.

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(String eventName,
                                      Object source)
Notify this object that it has been deregistered as a listener with a source for named event. This object is responsible for recording this fact.

Specified by:
disconnectionNotification in interface BeanCommon
Parameters:
eventName - the event
source - the source with which this object has been registered as a listener


Copyright © 2012 University of Waikato, Hamilton, NZ. All Rights Reserved.