Package weka.gui.beans
Class SubstringLabeler
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
weka.gui.beans.SubstringLabeler
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,EventListener,Accessible,EnvironmentHandler,BeanCommon,DataSource,DataSourceListener,EventConstraints,InstanceListener,TestSetListener,TrainingSetListener,Visible
@KFStep(category="Tools",
toolTipText="Label instances according to substring matches in String attributes")
public class SubstringLabeler
extends JPanel
implements BeanCommon, Visible, Serializable, InstanceListener, TrainingSetListener, TestSetListener, DataSourceListener, EventConstraints, EnvironmentHandler, DataSource
A bean that finds matches in string attribute values (using either substring
or regular expression matches) and labels the instance (sets the value of a
new attribute) according to the supplied label for the matching rule. The new
label attribute can be either multivalued nominal (if each match rule
specified has an explicit label associated with it) or, binary
numeric/nominal to indicate that one of the match rules has matched or not
matched.
- Version:
- $Revision: 11956 $
- 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 set eventvoidAccept and process an instance eventvoidAccept and process a test set eventvoidAccept and process a training set eventvoidAdd a datasource 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 receiving 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.booleanGet whether instances that do not match any of the rules should be "consumed" rather than output with a missing value set for the new attribute.Get the custom (descriptive) name for this bean (if one has been set)Get the internally encoded list of match rulesbooleanGet whether the new attribute created should be a nominal binary attribute rather than a numeric binary attribute.Get the visual representationHelp information suitable for displaying in the GUI.booleanisBusy()Returns true if.voidRemove a datasource listenervoidRemove an instance listenervoidsetConsumeNonMatching(boolean consume) Set whether instances that do not match any of the rules should be "consumed" rather than output with a missing value set for the new attribute.voidsetCustomName(String name) Set a custom (descriptive) name for this beanvoidSet environment variables to usevoidSet a loggervoidsetMatchAttributeName(String name) voidsetMatchDetails(String details) Set internally encoded list of match rulesvoidsetNominalBinary(boolean nom) Set whether the new attribute created should be a nominal binary attribute rather than a numeric binary attribute.voidsetVisual(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
-
SubstringLabeler
public SubstringLabeler()Constructor
-
-
Method Details
-
globalInfo
Help information suitable for displaying in the GUI.- Returns:
- a description of this component
-
setMatchDetails
Set internally encoded list of match rules- Parameters:
details- the list of match rules
-
getMatchDetails
Get the internally encoded list of match rules- Returns:
- the match rules
-
setNominalBinary
public void setNominalBinary(boolean nom) Set whether the new attribute created should be a nominal binary attribute rather than a numeric binary attribute.- Parameters:
nom- true if the attribute should be a nominal binary one
-
getNominalBinary
public boolean getNominalBinary()Get whether the new attribute created should be a nominal binary attribute rather than a numeric binary attribute.- Returns:
- true if the attribute should be a nominal binary one
-
setConsumeNonMatching
public void setConsumeNonMatching(boolean consume) Set whether instances that do not match any of the rules should be "consumed" rather than output with a missing value set for the new attribute.- Parameters:
consume- true if non matching instances should be consumed by the component.
-
getConsumeNonMatching
public boolean getConsumeNonMatching()Get whether instances that do not match any of the rules should be "consumed" rather than output with a missing value set for the new attribute.- Returns:
- true if non matching instances should be consumed by the component.
-
setMatchAttributeName
-
getMatchAttributeName
-
addDataSourceListener
Add a datasource listener- Specified by:
addDataSourceListenerin interfaceDataSource- Parameters:
dsl- the datasource listener to add
-
removeDataSourceListener
Remove a datasource listener- Specified by:
removeDataSourceListenerin interfaceDataSource- Parameters:
dsl- the datasource 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
-
setEnvironment
Set environment variables to use- Specified by:
setEnvironmentin interfaceEnvironmentHandler- Parameters:
env- the environment variables to use
-
eventGeneratable
Returns 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
-
useDefaultVisual
public void useDefaultVisual()Use the default visual representation- Specified by:
useDefaultVisualin interfaceVisible
-
setVisual
Set a new visual representation -
getVisual
Get the visual representation -
setCustomName
Set a custom (descriptive) name for this bean- Specified by:
setCustomNamein interfaceBeanCommon- Parameters:
name- the name to use
-
getCustomName
Get 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()Stop any processing that the bean might be doing.- Specified by:
stopin interfaceBeanCommon
-
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:
isBusyin interfaceBeanCommon- Returns:
- true if the bean is busy.
-
setLog
Set a logger- Specified by:
setLogin interfaceBeanCommon- Parameters:
logger- aweka.gui.Loggervalue
-
connectionAllowed
Returns 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
Returns 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
Notify this object that it has been registered as a listener with a source for receiving 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
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:
disconnectionNotificationin interfaceBeanCommon- Parameters:
eventName- the eventsource- the source with which this object has been registered as a listener
-
acceptInstance
Accept and process an instance event- Specified by:
acceptInstancein interfaceInstanceListener- Parameters:
e- the instance event to process
-
acceptDataSet
Accept and process a data set event- Specified by:
acceptDataSetin interfaceDataSourceListener- Parameters:
e- the data set event to process
-
acceptTestSet
Accept and process a test set event- Specified by:
acceptTestSetin interfaceTestSetListener- Parameters:
e- the test set event to process
-
acceptTrainingSet
Accept and process a training set event- Specified by:
acceptTrainingSetin interfaceTrainingSetListener- Parameters:
e- aTrainingSetEventvalue
-