weka.gui.knowledgeflow

Class StepTree

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

weka.gui.knowledgeflow.StepTree

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

public class StepTree
extends javax.swing.JTree

Subclass of JTree for displaying available steps.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	StepTree.StepIconRenderer

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

javax.swing.JTree.AccessibleJTree, javax.swing.JTree.DropLocation, javax.swing.JTree.DynamicUtilTreeNode, javax.swing.JTree.EmptySelectionModel, javax.swing.JTree.TreeModelHandler, javax.swing.JTree.TreeSelectionRedirector

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 MainKFPerspective	m_mainPerspective Reference to the main knowledge flow perspective
protected java.util.Map<java.lang.String,javax.swing.tree.DefaultMutableTreeNode>	m_nodeTextIndex Lookup for searching text of global info/tip texts
protected static java.lang.String	STEP_LIST_PROPS Property file that lists built-in steps

Fields inherited from class javax.swing.JTree

ANCHOR_SELECTION_PATH_PROPERTY, CELL_EDITOR_PROPERTY, CELL_RENDERER_PROPERTY, cellEditor, cellRenderer, editable, EDITABLE_PROPERTY, EXPANDS_SELECTED_PATHS_PROPERTY, INVOKES_STOP_CELL_EDITING_PROPERTY, invokesStopCellEditing, LARGE_MODEL_PROPERTY, largeModel, LEAD_SELECTION_PATH_PROPERTY, ROOT_VISIBLE_PROPERTY, rootVisible, ROW_HEIGHT_PROPERTY, rowHeight, SCROLLS_ON_EXPAND_PROPERTY, scrollsOnExpand, SELECTION_MODEL_PROPERTY, selectionModel, selectionRedirector, SHOWS_ROOT_HANDLES_PROPERTY, showsRootHandles, TOGGLE_CLICK_COUNT_PROPERTY, toggleClickCount, TREE_MODEL_PROPERTY, treeModel, treeModelListener, VISIBLE_ROW_COUNT_PROPERTY, visibleRowCount

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
StepTree(MainKFPerspective mainPerspective) Constructor

Method Summary

Modifier and Type	Method and Description
protected javax.swing.tree.DefaultMutableTreeNode	getCategoryFolder(javax.swing.tree.DefaultMutableTreeNode jtreeRoot, java.lang.String category) Get a folder for a particular category from the tree.
protected java.util.Map<java.lang.String,javax.swing.tree.DefaultMutableTreeNode>	getNodeTextIndex() Get the global info/tool tip text index
protected java.lang.String	getStepCategory(Step toAdd) Gets the category that the supplied step belongs to.
java.lang.String	getToolTipText(java.awt.event.MouseEvent e) Get tool tip text for the step closest to the mouse location in the StepTree.
protected java.util.Properties	initGOEProps() Initializes generic object editor properties
protected void	populateForWekaWrapper(javax.swing.tree.DefaultMutableTreeNode targetFolder, WekaAlgorithmWrapper wrapper, java.util.Properties GOEProps) Populates a target folder in the tree for a particular class of weka algorithm wrapper step
protected void	populateTree(javax.swing.tree.DefaultMutableTreeNode jtreeRoot) Populates the tree from the given root
protected void	populateTree(java.util.Set<java.lang.String> stepClasses, javax.swing.tree.DefaultMutableTreeNode jtreeRoot, java.util.Properties GOEProps) Populate the tree from the given root using a set of step classes
protected void	processPackage(HierarchyPropertyParser hpp, javax.swing.tree.DefaultMutableTreeNode parentFolder, WekaAlgorithmWrapper wrapper) Processes a package from the HierarchPropertyParser
void	setShowLeafTipText(boolean show) Turn on or off tool tip text popups for the steps in the tree

Methods inherited from class javax.swing.JTree

addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, cancelEditing, clearSelection, clearToggledPaths, collapsePath, collapseRow, convertValueToText, createTreeModel, createTreeModelListener, expandPath, expandRow, fireTreeCollapsed, fireTreeExpanded, fireTreeWillCollapse, fireTreeWillExpand, fireValueChanged, getAccessibleContext, getAnchorSelectionPath, getCellEditor, getCellRenderer, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getDropLocation, getDropMode, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getModel, getNextMatch, getPathBetweenRows, getPathBounds, getPathForLocation, getPathForRow, getPreferredScrollableViewportSize, getRowBounds, getRowCount, getRowForLocation, getRowForPath, getRowHeight, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollsOnExpand, getSelectionCount, getSelectionModel, getSelectionPath, getSelectionPaths, getSelectionRows, getShowsRootHandles, getToggleClickCount, getTreeExpansionListeners, getTreeSelectionListeners, getTreeWillExpandListeners, getUI, getUIClassID, getVisibleRowCount, hasBeenExpanded, isCollapsed, isCollapsed, isEditable, isEditing, isExpanded, isExpanded, isFixedRowHeight, isLargeModel, isPathEditable, isPathSelected, isRootVisible, isRowSelected, isSelectionEmpty, isVisible, makeVisible, paramString, removeDescendantSelectedPaths, removeDescendantToggledPaths, removeSelectionInterval, removeSelectionPath, removeSelectionPaths, removeSelectionRow, removeSelectionRows, removeTreeExpansionListener, removeTreeSelectionListener, removeTreeWillExpandListener, scrollPathToVisible, scrollRowToVisible, setAnchorSelectionPath, setCellEditor, setCellRenderer, setDragEnabled, setDropMode, setEditable, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setModel, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, startEditingAtPath, stopEditing, treeDidChange, 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, 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

STEP_LIST_PROPS

protected static final java.lang.String STEP_LIST_PROPS

Property file that lists built-in steps

See Also:

Constant Field Values

m_mainPerspective

protected MainKFPerspective m_mainPerspective

Reference to the main knowledge flow perspective

m_nodeTextIndex

protected java.util.Map<java.lang.String,javax.swing.tree.DefaultMutableTreeNode> m_nodeTextIndex

Lookup for searching text of global info/tip texts

Constructor Detail

StepTree

public StepTree(MainKFPerspective mainPerspective)

Constructor

Parameters:

mainPerspective - the main knowledge flow perspective

Method Detail

populateTree

protected void populateTree(javax.swing.tree.DefaultMutableTreeNode jtreeRoot)
                     throws java.lang.Exception

Populates the tree from the given root

Parameters:

jtreeRoot - the root to populate

Throws:

java.lang.Exception - if a problem occurs

populateTree

protected void populateTree(java.util.Set<java.lang.String> stepClasses,
                            javax.swing.tree.DefaultMutableTreeNode jtreeRoot,
                            java.util.Properties GOEProps)
                     throws java.lang.Exception

Populate the tree from the given root using a set of step classes

Parameters:

stepClasses - the set of step classes to go into the tree

jtreeRoot - the root of the tree

GOEProps - generic object editor properties

Throws:

java.lang.Exception - if a problem occurs

populateForWekaWrapper

protected void populateForWekaWrapper(javax.swing.tree.DefaultMutableTreeNode targetFolder,
                                      WekaAlgorithmWrapper wrapper,
                                      java.util.Properties GOEProps)
                               throws java.lang.Exception

Populates a target folder in the tree for a particular class of weka algorithm wrapper step

Parameters:

targetFolder - the folder to populate

wrapper - the WekaAlgorithmWrapper implementation

GOEProps - generic object editor properties

Throws:

java.lang.Exception - if a problem occurs

processPackage

protected void processPackage(HierarchyPropertyParser hpp,
                              javax.swing.tree.DefaultMutableTreeNode parentFolder,
                              WekaAlgorithmWrapper wrapper)
                       throws java.lang.Exception

Processes a package from the HierarchPropertyParser

Parameters:

hpp - the property parser to use

parentFolder - the folder to populate

wrapper - the WekaAlgorithmWrapper implementation to use for the class of algorithm being processed

Throws:

java.lang.Exception - if a problem occurs

getCategoryFolder

protected javax.swing.tree.DefaultMutableTreeNode getCategoryFolder(javax.swing.tree.DefaultMutableTreeNode jtreeRoot,
                                                                    java.lang.String category)

Get a folder for a particular category from the tree. Creates the category folder if it doesn't already exist

Parameters:

jtreeRoot - the root of the tree

category - the name of the category to get the folder for

Returns:

return the folder

getStepCategory

protected java.lang.String getStepCategory(Step toAdd)

Gets the category that the supplied step belongs to. Uses the info in the KFStep annotation; otherwise the default "Plugin" category is used.

Parameters:

toAdd - the step to get the category for

Returns:

the category name

initGOEProps

protected java.util.Properties initGOEProps()
                                     throws java.lang.Exception

Initializes generic object editor properties

Returns:

a properties object

Throws:

java.lang.Exception - if a problem occurs

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent e)

Get tool tip text for the step closest to the mouse location in the StepTree.

Overrides:

getToolTipText in class javax.swing.JTree

Parameters:

e - the MouseEvent containing the pointer location

Returns:

the tool tip for the closest step in the tree

setShowLeafTipText

public void setShowLeafTipText(boolean show)

Turn on or off tool tip text popups for the steps in the tree

Parameters:

show - true if tool tip text popups are to be shown

getNodeTextIndex

protected java.util.Map<java.lang.String,javax.swing.tree.DefaultMutableTreeNode> getNodeTextIndex()

Get the global info/tool tip text index

Returns:

the global info/tool tip text index