Package weka.gui.beans
Class FlowByExpression
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
weka.gui.beans.FlowByExpression
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,EventListener,Accessible,EnvironmentHandler,BeanCommon,DataSource,DataSourceListener,EventConstraints,InstanceListener,StructureProducer,TestSetListener,TrainingSetListener,Visible
@KFStep(category="Flow",
toolTipText="Route instances according to a boolean expression")
public class FlowByExpression
extends JPanel
implements BeanCommon, Visible, Serializable, InstanceListener, TrainingSetListener, TestSetListener, DataSourceListener, EventConstraints, EnvironmentHandler, DataSource, StructureProducer
A bean that splits incoming instances (or instance streams) according to the
evaluation of a logical expression. The expression can test the values of one
or more incoming attributes. The test can involve constants or comparing one
attribute's values to another. Inequalities along with string operations such
as contains, starts-with, ends-with and regular expressions may be used as
operators.
- Version:
- $Revision: 14912 $
- 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 TypeMethodDescriptionvoidvoidAccept and process an instance eventvoidAccept and process a test set eventvoidAccept and process a training setvoidAdd a data source listenervoidAdd an instance listenerbooleanReturns true if, at this time, the object will accept a connection via the named eventbooleanconnectionAllowed(String eventName) Returns true if, at this time, the object will accept a connection via the named eventvoidconnectionNotification(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.voiddisconnectionNotification(String eventName, Object source) Notify this object that it has been deregistered as a listener with a source for named event.booleaneventGeneratable(String eventName) Returns true if, at the current time, the named event could be generated.Returns the structure of the incoming instances (if any)Get the custom (descriptive) name for this bean (if one has been set)Get the current expression (in internal format)Get the name of the connected step to send "false" instances togetStructure(String eventName) Get the structure of the output encapsulated in the named event.Get the name of the connected step to send "true" instances toGet the visual representationbooleanisBusy()Returns true if.voidRemove a data source listenervoidRemove an instance listenervoidsetCustomName(String name) Set a custom (descriptive) name for this beanvoidSet environment variables to use.voidsetExpressionString(String expressionString) Set the expression (in internal format)voidsetFalseStepName(String falseStep) Set the name of the connected step to send "false" instances tovoidSet a loggervoidsetTrueStepName(String trueStep) Set the name of the connected step to send "true" instances tovoidsetVisual(BeanVisual newVisual) Set a new visual representationvoidstop()Stop any processing that the bean might be doing.voidUse the default visual representationMethods 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
-
FlowByExpression
public FlowByExpression()Constructor
-
-
Method Details
-
globalInfo
-
setExpressionString
Set the expression (in internal format)- Parameters:
expressionString- the expression to use (in internal format)
-
getExpressionString
Get the current expression (in internal format)- Returns:
- the current expression (in internal format)
-
setTrueStepName
Set the name of the connected step to send "true" instances to- Parameters:
trueStep- the name of the step to send "true" instances to
-
getTrueStepName
Get the name of the connected step to send "true" instances to- Returns:
- the name of the step to send "true" instances to
-
setFalseStepName
Set the name of the connected step to send "false" instances to- Parameters:
falseStep- the name of the step to send "false" instances to
-
getFalseStepName
Get the name of the connected step to send "false" instances to- Returns:
- the name of the step to send "false" instances to
-
addDataSourceListener
Description copied from interface:DataSourceAdd a data source listener- Specified by:
addDataSourceListenerin interfaceDataSource- Parameters:
dsl- aDataSourceListenervalue
-
removeDataSourceListener
Description copied from interface:DataSourceRemove a data source listener- Specified by:
removeDataSourceListenerin interfaceDataSource- Parameters:
dsl- aDataSourceListenervalue
-
addInstanceListener
Description copied from interface:DataSourceAdd an instance listener- Specified by:
addInstanceListenerin interfaceDataSource- Parameters:
dsl- anInstanceListenervalue
-
removeInstanceListener
Description copied from interface:DataSourceRemove an instance listener- Specified by:
removeInstanceListenerin interfaceDataSource- Parameters:
dsl- anInstanceListenervalue
-
setEnvironment
Description copied from interface:EnvironmentHandlerSet environment variables to use.- Specified by:
setEnvironmentin interfaceEnvironmentHandler- Parameters:
env- the environment variables to use
-
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
-
acceptDataSet
- Specified by:
acceptDataSetin interfaceDataSourceListener
-
acceptTestSet
Description copied from interface:TestSetListenerAccept and process a test set event- Specified by:
acceptTestSetin interfaceTestSetListener- Parameters:
e- aTestSetEventvalue
-
acceptTrainingSet
Description copied from interface:TrainingSetListenerAccept and process a training set- Specified by:
acceptTrainingSetin interfaceTrainingSetListener- Parameters:
e- aTrainingSetEventvalue
-
acceptInstance
Description copied from interface:InstanceListenerAccept and process an instance event- Specified by:
acceptInstancein interfaceInstanceListener- Parameters:
e- anInstanceEventvalue
-
useDefaultVisual
public void useDefaultVisual()Description copied from interface:VisibleUse the default visual representation- Specified by:
useDefaultVisualin interfaceVisible
-
setVisual
Description copied from interface:VisibleSet a new visual representation -
getVisual
Description copied from interface:VisibleGet the visual representation -
setCustomName
Description copied from interface:BeanCommonSet a custom (descriptive) name for this bean- Specified by:
setCustomNamein interfaceBeanCommon- Parameters:
name- the name to use
-
getCustomName
Description copied from interface:BeanCommonGet the custom (descriptive) name for this bean (if one has been set)- Specified by:
getCustomNamein interfaceBeanCommon- Returns:
- the custom name (or the default name)
-
stop
public void stop()Description copied from interface:BeanCommonStop any processing that the bean might be doing.- Specified by:
stopin interfaceBeanCommon
-
isBusy
public boolean isBusy()Description copied from interface:BeanCommonReturns true if. at this time, the bean is busy with some (i.e. perhaps a worker thread is performing some calculation).- Specified by:
isBusyin interfaceBeanCommon- Returns:
- true if the bean is busy.
-
setLog
Description copied from interface:BeanCommonSet a logger- Specified by:
setLogin interfaceBeanCommon- Parameters:
logger- aweka.gui.Loggervalue
-
connectionAllowed
Description copied from interface:BeanCommonReturns true if, at this time, the object will accept a connection via the named event- Specified by:
connectionAllowedin interfaceBeanCommon- Parameters:
esd- the EventSetDescriptor for the event in question- Returns:
- true if the object will accept a connection
-
connectionAllowed
Description copied from interface:BeanCommonReturns true if, at this time, the object will accept a connection via the named event- Specified by:
connectionAllowedin interfaceBeanCommon- Parameters:
eventName- the name of the event- Returns:
- true if the object will accept a connection
-
connectionNotification
Description copied from interface:BeanCommonNotify 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:
connectionNotificationin interfaceBeanCommon- Parameters:
eventName- the eventsource- the source with which this object has been registered as a listener
-
disconnectionNotification
Description copied from interface:BeanCommonNotify 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:
disconnectionNotificationin interfaceBeanCommon- Parameters:
eventName- the eventsource- the source with which this object has been registered as a listener
-
getStructure
Get the structure of the output encapsulated in the named event. If the structure can't be determined in advance of seeing input, or this StructureProducer does not generate the named event, null should be returned.- Specified by:
getStructurein interfaceStructureProducer- Parameters:
eventName- the name of the output event that encapsulates the requested output.- Returns:
- the structure of the output encapsulated in the named event or null if it can't be determined in advance of seeing input or the named event is not generated by this StructureProducer.
-
getConnectedFormat
Returns the structure of the incoming instances (if any)- Returns:
- an
Instancesvalue
-