Join (interruptible-weka 0.1.2 API)

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

All Implemented Interfaces:: java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.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 javax.swing.JPanel
implements BeanCommon, Visible, java.io.Serializable, DataSource, DataSourceListener, TrainingSetListener, TestSetListener, InstanceListener, EventConstraints, StructureProducer, EnvironmentHandler

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Join.InstanceHolder` Small helper class for holding an instance and the values of any string attributes it might have.

Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`KEY_SPEC_SEPARATOR` Separator used to separate first and second input key specifications
`protected boolean`	`m_busy` True if we are busy
`protected java.util.concurrent.atomic.AtomicInteger`	`m_count` Used to cycle over the headers in the header pool
`protected java.util.ArrayList<DataSourceListener>`	`m_dataListeners` Downstream steps listening to batch data events
`protected Environment`	`m_env` Environment variables
`protected java.util.Queue<Join.InstanceHolder>`	`m_firstBuffer` Buffer for the first input (capped at 100 for incremental)
`protected boolean`	`m_firstFinished` Whether the first is finished (incremental mode)
`protected java.lang.Object`	`m_firstInput` The first source of data
`protected java.lang.String`	`m_firstInputConnectionType` Connection type of the first input
`protected boolean`	`m_firstIsWaiting` True if the first input stream is waiting due to a full buffer (incremental mode only)
`protected Instances`	`m_headerOne` The structure of the first incoming dataset
`protected java.util.List<Instances>`	`m_headerPool` A set of copied outgoing structure instances.
`protected Instances`	`m_headerTwo` The structure of the second incoming dataset
`protected InstanceEvent`	`m_ie` Instance event to use for incremental mode
`protected boolean`	`m_incomingBatchConnections` Upstream components sending us data
`protected java.util.ArrayList<InstanceListener>`	`m_instanceListeners` Downstream steps listening to instance events
`protected int[]`	`m_keyIndexesOne` Indexes of the key fields for the first input
`protected int[]`	`m_keyIndexesTwo` Indexes of the key fields for the second input
`protected java.lang.String`	`m_keySpec` Holds the internal representation of the key specification
`protected Logger`	`m_log` Logging
`protected Instances`	`m_mergedHeader` The structure of the outgoing dataset
`protected boolean`	`m_runningIncrementally` True if the step is running incrementally
`protected java.util.Queue<Join.InstanceHolder>`	`m_secondBuffer` Buffer for the second input (capped at 100 for incremental)
`protected boolean`	`m_secondFinished` Whether the second is finished (incremental mode)
`protected java.lang.Object`	`m_secondInput` The second source of data
`protected java.lang.String`	`m_secondInputConnectionType` Connection type of the second input
`protected boolean`	`m_secondIsWaiting` True if the second input stream is waiting due to a full buffer (incremental mode only)
`protected java.util.concurrent.atomic.AtomicBoolean`	`m_stopRequested` True if the step has been told to stop processing
`protected java.util.Map<java.lang.String,java.lang.Integer>`	`m_stringAttIndexesOne` Holds indexes of string attributes, keyed by attribute name
`protected java.util.Map<java.lang.String,java.lang.Integer>`	`m_stringAttIndexesTwo` Holds indexes of string attributes, keyed by attribute name
`protected boolean`	`m_stringAttsPresent` True if string attributes are present in the incoming data
`protected StreamThroughput`	`m_throughput` Used for computing streaming throughput stats
`protected BeanVisual`	`m_visual` Default visual for data sources

Fields inherited from class javax.swing.JComponent
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.Component
accessibleContext, 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

Constructors
Constructor and Description

Join()
Constructor

Constructors
Constructor and Description
`Join()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptDataSet(DataSetEvent e)` Accept and process a data set
`void`	`acceptInstance(InstanceEvent e)` Accept and process an instance event
`void`	`acceptTestSet(TestSetEvent e)` Accept and process a test set
`void`	`acceptTrainingSet(TrainingSetEvent e)` Accept and process a training set
`void`	`addDataSourceListener(DataSourceListener dsl)` Add a data source listener
`void`	`addInstanceListener(InstanceListener dsl)` Add an instance listener
`protected void`	`addToFirstBuffer(Instance inst)` Adds an instance to the first input's buffer
`protected void`	`addToSecondBuffer(Instance inst)` Adds an instance to the second input's buffer
`protected void`	`clearBuffers()` Clear remaining instances in the buffers
`protected int`	`compare(Instance one, Instance two, Join.InstanceHolder oneH, Join.InstanceHolder twoH)` Compares two instances according to the keys
`boolean`	`connectionAllowed(java.beans.EventSetDescriptor esd)` Returns true if the named connection can be made at this time
`boolean`	`connectionAllowed(java.lang.String eventName)` Returns true if the named connection can be made at this time
`void`	`connectionNotification(java.lang.String eventName, java.lang.Object source)` Deals with a new connection
`void`	`disconnectionNotification(java.lang.String eventName, java.lang.Object source)` Handles cleanup when an upstream step disconnects
`boolean`	`eventGeneratable(java.lang.String eventName)` Returns true if, at the current time, the named event could be generated.
`protected void`	`generateMergedHeader()` Generate the header of the output instance structure
`protected Instance`	`generateMergedInstance(Join.InstanceHolder one, Join.InstanceHolder two)` Generate a merged instance from two input instances that match on the key fields
`java.lang.String`	`getCustomName()` Get the custom name of this step
`protected java.lang.Object`	`getFirstInput()` Get the first input step
`protected Instances`	`getFirstInputStructure()` Get the first input structure
`java.lang.String`	`getKeySpec()` Get the key specification (in internal format - k11,k12,...
`protected java.lang.Object`	`getSecondInput()` Get the second input step
`protected Instances`	`getSecondInputStructure()` Get the second input structure
`Instances`	`getStructure(java.lang.String eventName)` Get the output instances structure given an input event type
`protected Instances`	`getUpstreamStructureFirst()` Get the incoming instance structure from the first upstream step (if possible)
`protected Instances`	`getUpstreamStructureSecond()` Get the incoming instance structure from the second upstream step (if possible)
`BeanVisual`	`getVisual()` Get the visual for this step
`java.lang.String`	`globalInfo()` Global info for the method
`boolean`	`isBusy()` Returns true if we are doing something
`protected Instance`	`processBuffers()` Process the current state of the two buffers.
`void`	`removeDataSourceListener(DataSourceListener dsl)` Remove a data souce listener
`void`	`removeInstanceListener(InstanceListener dsl)` Remove an instance listener
`void`	`setCustomName(java.lang.String name)` Set a custom name for this step
`void`	`setEnvironment(Environment env)` Set environment variables to use
`void`	`setKeySpec(java.lang.String ks)` Set the key specification (in internal format - k11,k12,...
`void`	`setLog(Logger logger)` Set a log to use
`void`	`setVisual(BeanVisual newVisual)` Set the visual for this step
`void`	`stop()` Attempt to stop processing
`void`	`useDefaultVisual()` Use the default visual for this step

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, 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, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, 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, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, 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, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - KEY_SPEC_SEPARATOR
```
protected static final java.lang.String KEY_SPEC_SEPARATOR
```
    Separator used to separate first and second input key specifications
    
    See Also:
    
    Constant Field Values
  - m_log
```
protected transient Logger m_log
```
    Logging
  - m_env
```
protected transient Environment m_env
```
    Environment variables
  - m_incomingBatchConnections
```
protected boolean m_incomingBatchConnections
```
    Upstream components sending us data
  - m_firstInput
```
protected java.lang.Object m_firstInput
```
    The first source of data
  - m_secondInput
```
protected java.lang.Object m_secondInput
```
    The second source of data
  - m_firstFinished
```
protected transient boolean m_firstFinished
```
    Whether the first is finished (incremental mode)
  - m_secondFinished
```
protected transient boolean m_secondFinished
```
    Whether the second is finished (incremental mode)
  - m_firstInputConnectionType
```
protected java.lang.String m_firstInputConnectionType
```
    Connection type of the first input
  - m_secondInputConnectionType
```
protected java.lang.String m_secondInputConnectionType
```
    Connection type of the second input
  - m_firstBuffer
```
protected transient java.util.Queue<Join.InstanceHolder> m_firstBuffer
```
    Buffer for the first input (capped at 100 for incremental)
  - m_secondBuffer
```
protected transient java.util.Queue<Join.InstanceHolder> m_secondBuffer
```
    Buffer for the second input (capped at 100 for incremental)
  - m_ie
```
protected InstanceEvent m_ie
```
    Instance event to use for incremental mode
  - m_headerOne
```
protected transient Instances m_headerOne
```
    The structure of the first incoming dataset
  - m_headerTwo
```
protected transient Instances m_headerTwo
```
    The structure of the second incoming dataset
  - m_mergedHeader
```
protected transient Instances m_mergedHeader
```
    The structure of the outgoing dataset
  - m_headerPool
```
protected transient java.util.List<Instances> m_headerPool
```
    A set of copied outgoing structure instances. Used when there are string attributes present in the incremental case in order to prevent concurrency problems where string values could get clobbered in the header.
  - m_count
```
protected transient java.util.concurrent.atomic.AtomicInteger m_count
```
    Used to cycle over the headers in the header pool
  - m_stringAttsPresent
```
protected boolean m_stringAttsPresent
```
    True if string attributes are present in the incoming data
  - m_runningIncrementally
```
protected boolean m_runningIncrementally
```
    True if the step is running incrementally
  - m_keyIndexesOne
```
protected int[] m_keyIndexesOne
```
    Indexes of the key fields for the first input
  - m_keyIndexesTwo
```
protected int[] m_keyIndexesTwo
```
    Indexes of the key fields for the second input
  - m_keySpec
```
protected java.lang.String m_keySpec
```
    Holds the internal representation of the key specification
  - m_busy
```
protected boolean m_busy
```
    True if we are busy
  - m_stopRequested
```
protected java.util.concurrent.atomic.AtomicBoolean m_stopRequested
```
    True if the step has been told to stop processing
  - m_stringAttIndexesOne
```
protected java.util.Map<java.lang.String,java.lang.Integer> m_stringAttIndexesOne
```
    Holds indexes of string attributes, keyed by attribute name
  - m_stringAttIndexesTwo
```
protected java.util.Map<java.lang.String,java.lang.Integer> m_stringAttIndexesTwo
```
    Holds indexes of string attributes, keyed by attribute name
  - m_firstIsWaiting
```
protected boolean m_firstIsWaiting
```
    True if the first input stream is waiting due to a full buffer (incremental mode only)
  - m_secondIsWaiting
```
protected boolean m_secondIsWaiting
```
    True if the second input stream is waiting due to a full buffer (incremental mode only)
  - m_visual
```
protected BeanVisual m_visual
```
    Default visual for data sources
  - m_dataListeners
```
protected java.util.ArrayList<DataSourceListener> m_dataListeners
```
    Downstream steps listening to batch data events
  - m_instanceListeners
```
protected java.util.ArrayList<InstanceListener> m_instanceListeners
```
    Downstream steps listening to instance events
  - m_throughput
```
protected transient StreamThroughput m_throughput
```
    Used for computing streaming throughput stats
- Constructor Detail
  - Join
```
public Join()
```
    Constructor
- Method Detail
  - globalInfo
```
public java.lang.String globalInfo()
```
    Global info for the method
    
    Returns:
    
    the global help info
  - setKeySpec
```
public void setKeySpec(java.lang.String ks)
```
    Set the key specification (in internal format - k11,k12,...,k1nKEY_SPEC_SEPARATORk21,k22,...,k2n)
    
    Parameters:
    
    ks - the keys specification
  - getKeySpec
```
public java.lang.String getKeySpec()
```
    Get the key specification (in internal format - k11,k12,...,k1nKEY_SPEC_SEPARATORk21,k22,...,k2n)
    
    Returns:
    
    the keys specification
  - eventGeneratable
```
public boolean eventGeneratable(java.lang.String eventName)
```
    Description copied from interface: EventConstraints
    
    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
  - generateMergedHeader
```
protected void generateMergedHeader()
```
    Generate the header of the output instance structure
  - generateMergedInstance
```
protected Instance generateMergedInstance(Join.InstanceHolder one,
                                          Join.InstanceHolder two)
```
    Generate a merged instance from two input instances that match on the key fields
    
    Parameters:
    
    one - the first input instance
    
    two - the second input instance
    
    Returns:
    
    the merged instance
  - acceptInstance
```
public void acceptInstance(InstanceEvent e)
```
    Description copied from interface: InstanceListener
    
    Accept and process an instance event
    
    Specified by:
    
    acceptInstance in interface InstanceListener
    
    Parameters:
    
    e - an InstanceEvent value
  - addToFirstBuffer
```
protected void addToFirstBuffer(Instance inst)
```
    Adds an instance to the first input's buffer
    
    Parameters:
    
    inst - the instance to add
  - addToSecondBuffer
```
protected void addToSecondBuffer(Instance inst)
```
    Adds an instance to the second input's buffer
    
    Parameters:
    
    inst - the instance to add
  - clearBuffers
```
protected void clearBuffers()
```
    Clear remaining instances in the buffers
  - processBuffers
```
protected Instance processBuffers()
```
    Process the current state of the two buffers. Compares the head of both buffers and will return a merged instance if they match on the key fields. Will remove instances from one or the other buffer if it is behind according to the keys comparison
    
    Returns:
    
    a merged instance if keys match, otherwise null
  - compare
```
protected int compare(Instance one,
                      Instance two,
                      Join.InstanceHolder oneH,
                      Join.InstanceHolder twoH)
```
    Compares two instances according to the keys
    
    Parameters:
    
    one - the first instance
    
    two - the second instance
    
    oneH - the first instance holder (in case string attributes are present and we are running incrementally)
    
    twoH - the second instance holder
    
    Returns:
    
    the comparison according to the keys
  - acceptTestSet
```
public void acceptTestSet(TestSetEvent e)
```
    Accept and process a test set
    
    Specified by:
    
    acceptTestSet in interface TestSetListener
    
    Parameters:
    
    e - the test set event encapsulating the test set
  - acceptTrainingSet
```
public void acceptTrainingSet(TrainingSetEvent e)
```
    Accept and process a training set
    
    Specified by:
    
    acceptTrainingSet in interface TrainingSetListener
    
    Parameters:
    
    e - the training set event encapsulating the training set
  - acceptDataSet
```
public void acceptDataSet(DataSetEvent e)
```
    Accept and process a data set
    
    Specified by:
    
    acceptDataSet in interface DataSourceListener
    
    Parameters:
    
    e - the data set event encapsulating the data set
  - addDataSourceListener
```
public void addDataSourceListener(DataSourceListener dsl)
```
    Add a data source listener
    
    Specified by:
    
    addDataSourceListener in interface DataSource
    
    Parameters:
    
    dsl - the data source listener to add
  - removeDataSourceListener
```
public void removeDataSourceListener(DataSourceListener dsl)
```
    Remove a data souce listener
    
    Specified by:
    
    removeDataSourceListener in interface DataSource
    
    Parameters:
    
    dsl - the data source listener to remove
  - addInstanceListener
```
public void addInstanceListener(InstanceListener dsl)
```
    Add an instance listener
    
    Specified by:
    
    addInstanceListener in interface DataSource
    
    Parameters:
    
    dsl - the instance listener to add
  - removeInstanceListener
```
public void removeInstanceListener(InstanceListener dsl)
```
    Remove an instance listener
    
    Specified by:
    
    removeInstanceListener in interface DataSource
    
    Parameters:
    
    dsl - the instance listener to remove
  - useDefaultVisual
```
public void useDefaultVisual()
```
    Use the default visual for this step
    
    Specified by:
    
    useDefaultVisual in interface Visible
  - setVisual
```
public void setVisual(BeanVisual newVisual)
```
    Set the visual for this step
    
    Specified by:
    
    setVisual in interface Visible
    
    Parameters:
    
    newVisual - the visual to use
  - getVisual
```
public BeanVisual getVisual()
```
    Get the visual for this step
    
    Specified by:
    
    getVisual in interface Visible
    
    Returns:
    
    the visual (icon)
  - setCustomName
```
public void setCustomName(java.lang.String name)
```
    Set a custom name for this step
    
    Specified by:
    
    setCustomName in interface BeanCommon
    
    Parameters:
    
    name - the custom name to use
  - getCustomName
```
public java.lang.String getCustomName()
```
    Get the custom name of this step
    
    Specified by:
    
    getCustomName in interface BeanCommon
    
    Returns:
    
    the custom name of this step
  - stop
```
public void stop()
```
    Attempt to stop processing
    
    Specified by:
    
    stop in interface BeanCommon
  - isBusy
```
public boolean isBusy()
```
    Returns true if we are doing something
    
    Specified by:
    
    isBusy in interface BeanCommon
    
    Returns:
    
    true if processing is occurring
  - setLog
```
public void setLog(Logger logger)
```
    Set a log to use
    
    Specified by:
    
    setLog in interface BeanCommon
    
    Parameters:
    
    logger - the log to use
  - connectionAllowed
```
public boolean connectionAllowed(java.beans.EventSetDescriptor esd)
```
    Returns true if the named connection can be made at this time
    
    Specified by:
    
    connectionAllowed in interface BeanCommon
    
    Parameters:
    
    esd - the event set descriptor of the connection
    
    Returns:
    
    true if the connection is allowed
  - connectionAllowed
```
public boolean connectionAllowed(java.lang.String eventName)
```
    Returns true if the named connection can be made at this time
    
    Specified by:
    
    connectionAllowed in interface BeanCommon
    
    Parameters:
    
    eventName - the name of the connection
    
    Returns:
    
    true if the connection is allowed
  - connectionNotification
```
public void connectionNotification(java.lang.String eventName,
                                   java.lang.Object source)
```
    Deals with a new connection
    
    Specified by:
    
    connectionNotification in interface BeanCommon
    
    Parameters:
    
    eventName - the event type of the connection
    
    source - the source step
  - disconnectionNotification
```
public void disconnectionNotification(java.lang.String eventName,
                                      java.lang.Object source)
```
    Handles cleanup when an upstream step disconnects
    
    Specified by:
    
    disconnectionNotification in interface BeanCommon
    
    Parameters:
    
    eventName - the event type of the connection
    
    source - the source step
  - getUpstreamStructureFirst
```
protected Instances getUpstreamStructureFirst()
```
    Get the incoming instance structure from the first upstream step (if possible)
    
    Returns:
    
    the incoming instance structure of the first upstream step
  - getUpstreamStructureSecond
```
protected Instances getUpstreamStructureSecond()
```
    Get the incoming instance structure from the second upstream step (if possible)
    
    Returns:
    
    the incoming instance structure of the second upstream step
  - getFirstInput
```
protected java.lang.Object getFirstInput()
```
    Get the first input step
    
    Returns:
    
    the first input step
  - getFirstInputStructure
```
protected Instances getFirstInputStructure()
```
    Get the first input structure
    
    Returns:
    
    the first incoming instance structure (or null if unavailable)
  - getSecondInput
```
protected java.lang.Object getSecondInput()
```
    Get the second input step
    
    Returns:
    
    the second input step
  - getSecondInputStructure
```
protected Instances getSecondInputStructure()
```
    Get the second input structure
    
    Returns:
    
    the second incoming instance structure (or null if unavailable)
  - getStructure
```
public Instances getStructure(java.lang.String eventName)
```
    Get the output instances structure given an input event type
    
    Specified by:
    
    getStructure in interface StructureProducer
    
    Parameters:
    
    eventName - the name of the input event type
    
    Returns:
    
    the output instances structure (or null)
  - setEnvironment
```
public void setEnvironment(Environment env)
```
    Set environment variables to use
    
    Specified by:
    
    setEnvironment in interface EnvironmentHandler
    
    Parameters:
    
    env - the environment variables to use

Class Join

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

KEY_SPEC_SEPARATOR

m_log

m_env

m_incomingBatchConnections

m_firstInput

m_secondInput

m_firstFinished

m_secondFinished

m_firstInputConnectionType

m_secondInputConnectionType

m_firstBuffer

m_secondBuffer

m_ie

m_headerOne

m_headerTwo

m_mergedHeader

m_headerPool

m_count

m_stringAttsPresent

m_runningIncrementally

m_keyIndexesOne

m_keyIndexesTwo

m_keySpec

m_busy

m_stopRequested

m_stringAttIndexesOne

m_stringAttIndexesTwo

m_firstIsWaiting

m_secondIsWaiting

m_visual

m_dataListeners

m_instanceListeners

m_throughput

Constructor Detail

Join

Method Detail

globalInfo

setKeySpec

getKeySpec

eventGeneratable

generateMergedHeader

generateMergedInstance

acceptInstance

addToFirstBuffer

addToSecondBuffer

clearBuffers

processBuffers

compare

acceptTestSet

acceptTrainingSet

acceptDataSet

addDataSourceListener

removeDataSourceListener

addInstanceListener

removeInstanceListener

useDefaultVisual

setVisual

getVisual

setCustomName

getCustomName

stop

isBusy