Package weka.gui.beans
Class Join
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
weka.gui.beans.Join
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,EventListener,Accessible,EnvironmentHandler,BeanCommon,DataSource,DataSourceListener,EventConstraints,InstanceListener,StructureProducer,TestSetListener,TrainingSetListener,Visible
@KFStep(category="Flow",
toolTipText="Inner join on one or more key fields")
public class Join
extends JPanel
implements BeanCommon, Visible, Serializable, DataSource, DataSourceListener, TrainingSetListener, TestSetListener, InstanceListener, EventConstraints, StructureProducer, EnvironmentHandler
- Version:
- $Revision: 11251 $
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com)
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested 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_WINDOWFields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAccept and process a data setvoidAccept and process an instance eventvoidAccept and process a test setvoidAccept and process a training setvoidAdd a data source listenervoidAdd an instance listenerbooleanReturns true if the named connection can be made at this timebooleanconnectionAllowed(String eventName) Returns true if the named connection can be made at this timevoidconnectionNotification(String eventName, Object source) Deals with a new connectionvoiddisconnectionNotification(String eventName, Object source) Handles cleanup when an upstream step disconnectsbooleaneventGeneratable(String eventName) Returns true if, at the current time, the named event could be generated.Get the custom name of this stepGet the key specification (in internal format - k11,k12,...,k1nKEY_SPEC_SEPARATORk21,k22,...,k2n)getStructure(String eventName) Get the output instances structure given an input event typeGet the visual for this stepGlobal info for the methodbooleanisBusy()Returns true if we are doing somethingvoidRemove a data souce listenervoidRemove an instance listenervoidsetCustomName(String name) Set a custom name for this stepvoidSet environment variables to usevoidsetKeySpec(String ks) Set the key specification (in internal format - k11,k12,...,k1nKEY_SPEC_SEPARATORk21,k22,...,k2n)voidSet a log to usevoidsetVisual(BeanVisual newVisual) Set the visual for this stepvoidstop()Attempt to stop processingvoidUse the default visual for this stepMethods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUIMethods 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, hide, 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, updateMethods 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, transferFocusDownCycle, validateMethods 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
Join
public Join()Constructor
-
-
Method Details
-
globalInfo
Global info for the method- Returns:
- the global help info
-
setKeySpec
Set the key specification (in internal format - k11,k12,...,k1nKEY_SPEC_SEPARATORk21,k22,...,k2n)- Parameters:
ks- the keys specification
-
getKeySpec
Get the key specification (in internal format - k11,k12,...,k1nKEY_SPEC_SEPARATORk21,k22,...,k2n)- Returns:
- the keys specification
-
eventGeneratable
Description copied from interface:EventConstraintsReturns true if, at the current time, the named event could be generated.- Specified by:
eventGeneratablein interfaceEventConstraints- Parameters:
eventName- the name of the event in question- Returns:
- true if the named event could be generated
-
acceptInstance
Description copied from interface:InstanceListenerAccept and process an instance event- Specified by:
acceptInstancein interfaceInstanceListener- Parameters:
e- anInstanceEventvalue
-
acceptTestSet
Accept and process a test set- Specified by:
acceptTestSetin interfaceTestSetListener- Parameters:
e- the test set event encapsulating the test set
-
acceptTrainingSet
Accept and process a training set- Specified by:
acceptTrainingSetin interfaceTrainingSetListener- Parameters:
e- the training set event encapsulating the training set
-
acceptDataSet
Accept and process a data set- Specified by:
acceptDataSetin interfaceDataSourceListener- Parameters:
e- the data set event encapsulating the data set
-
addDataSourceListener
Add a data source listener- Specified by:
addDataSourceListenerin interfaceDataSource- Parameters:
dsl- the data source listener to add
-
removeDataSourceListener
Remove a data souce listener- Specified by:
removeDataSourceListenerin interfaceDataSource- Parameters:
dsl- the data source listener to remove
-
addInstanceListener
Add an instance listener- Specified by:
addInstanceListenerin interfaceDataSource- Parameters:
dsl- the instance listener to add
-
removeInstanceListener
Remove an instance listener- Specified by:
removeInstanceListenerin interfaceDataSource- Parameters:
dsl- the instance listener to remove
-
useDefaultVisual
public void useDefaultVisual()Use the default visual for this step- Specified by:
useDefaultVisualin interfaceVisible
-
setVisual
Set the visual for this step -
getVisual
Get the visual for this step -
setCustomName
Set a custom name for this step- Specified by:
setCustomNamein interfaceBeanCommon- Parameters:
name- the custom name to use
-
getCustomName
Get the custom name of this step- Specified by:
getCustomNamein interfaceBeanCommon- Returns:
- the custom name of this step
-
stop
public void stop()Attempt to stop processing- Specified by:
stopin interfaceBeanCommon
-
isBusy
public boolean isBusy()Returns true if we are doing something- Specified by:
isBusyin interfaceBeanCommon- Returns:
- true if processing is occurring
-
setLog
Set a log to use- Specified by:
setLogin interfaceBeanCommon- Parameters:
logger- the log to use
-
connectionAllowed
Returns true if the named connection can be made at this time- Specified by:
connectionAllowedin interfaceBeanCommon- Parameters:
esd- the event set descriptor of the connection- Returns:
- true if the connection is allowed
-
connectionAllowed
Returns true if the named connection can be made at this time- Specified by:
connectionAllowedin interfaceBeanCommon- Parameters:
eventName- the name of the connection- Returns:
- true if the connection is allowed
-
connectionNotification
Deals with a new connection- Specified by:
connectionNotificationin interfaceBeanCommon- Parameters:
eventName- the event type of the connectionsource- the source step
-
disconnectionNotification
Handles cleanup when an upstream step disconnects- Specified by:
disconnectionNotificationin interfaceBeanCommon- Parameters:
eventName- the event type of the connectionsource- the source step
-
getStructure
Get the output instances structure given an input event type- Specified by:
getStructurein interfaceStructureProducer- Parameters:
eventName- the name of the input event type- Returns:
- the output instances structure (or null)
-
setEnvironment
Set environment variables to use- Specified by:
setEnvironmentin interfaceEnvironmentHandler- Parameters:
env- the environment variables to use
-