weka.gui.explorer

Class AssociationsPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

weka.gui.AbstractPerspective

weka.gui.explorer.AssociationsPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, Explorer.CapabilitiesFilterChangeListener, Explorer.ExplorerPanel, Explorer.LogHandler, Perspective

@PerspectiveInfo(ID="weka.gui.explorer.associationspanel",
                 title="Associate",
                 toolTipText="Discover association rules",
                 iconPath="weka/gui/weka_icon_new_small.png")
public class AssociationsPanel
extends AbstractPerspective
implements Explorer.CapabilitiesFilterChangeListener, Explorer.ExplorerPanel, Explorer.LogHandler

This panel allows the user to select, configure, and run a scheme that learns associations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AssociationsPanel.AssociationsPanelDefaults Default settings for the associations panel

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 GenericObjectEditor	m_AssociatorEditor Lets the user configure the associator
protected PropertyPanel	m_CEPanel The panel showing the current associator selection
protected Explorer	m_Explorer the parent frame
protected ResultHistoryPanel	m_History A panel controlling results viewing
protected boolean	m_initialSettingsSet Whether start-up settings have been applied (i.e. initial default associator to use
protected Instances	m_Instances The main set of instances we're playing with
protected Logger	m_Log The destination for log/status messages
protected javax.swing.JTextArea	m_OutText The output area for associations
protected java.lang.Thread	m_RunThread A thread that associator runs in
protected SaveBuffer	m_SaveOut The buffer saving object for saving output
protected javax.swing.JButton	m_StartBut Click to start running the associator
protected javax.swing.JButton	m_StopBut Click to stop a running associator
protected javax.swing.JCheckBox	m_storeOutput Whether to store any graph or xml rules output in the history list
protected Instances	m_TestInstances The user-supplied test set (if any)

Fields inherited from class weka.gui.AbstractPerspective

m_isActive, m_isLoaded, m_log, m_mainApplication, m_perspectiveIcon, m_perspectiveID, m_perspectiveTipText, m_perspectiveTitle

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
AssociationsPanel() Creates the associator panel

Method Summary

Modifier and Type	Method and Description
boolean	acceptsInstances() Returns true if this perspective can do something meaningful with a set of instances
void	capabilitiesFilterChanged(Explorer.CapabilitiesFilterChangeEvent e) method gets called in case of a change event
Defaults	getDefaultSettings() Get the default settings for this perspective (or null if there are none)
Explorer	getExplorer() returns the parent Explorer frame
java.lang.String	getTabTitle() Returns the title for the tab in the Explorer
java.lang.String	getTabTitleToolTip() Returns the tooltip for the tab in the Explorer
protected void	historyRightClickPopup(java.util.List<java.lang.String> names, int x, int y) Handles constructing a popup menu with visualization options.
static void	main(java.lang.String[] args) Tests out the Associator panel from the command line.
boolean	okToBeActive() Returns true if the perspective is usable at this time.
boolean	requiresLog() Whether this perspective requires a graphical log to write to
protected void	saveBuffer(java.lang.String name) Save the currently selected associator output to a file.
void	setActive(boolean active) Set active status of this perspective.
void	setExplorer(Explorer parent) Sets the Explorer to use as parent frame (used for sending notifications about changes in the data)
void	setInstances(Instances inst) Tells the panel to use a new set of instances.
void	setLog(Logger newLog) Sets the Logger to receive informational messages
void	settingsChanged() Called when the user alters settings.
protected void	startAssociator() Starts running the currently configured associator with the current settings.
protected void	stopAssociator() Stops the currently running Associator (if any).
protected void	updateCapabilitiesFilter(Capabilities filter) updates the capabilities filter of the GOE
protected void	visualizeTree(java.lang.String dottyString, java.lang.String treeName) Pops up a TreeVisualizer for the associator from the currently selected item in the results list

Methods inherited from class weka.gui.AbstractPerspective

getMainApplication, getMenus, getPerspectiveIcon, getPerspectiveID, getPerspectiveTipText, getPerspectiveTitle, instantiationComplete, setLoaded, setMainApplication, toString

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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Explorer

protected Explorer m_Explorer

the parent frame

m_AssociatorEditor

protected GenericObjectEditor m_AssociatorEditor

Lets the user configure the associator

m_CEPanel

protected PropertyPanel m_CEPanel

The panel showing the current associator selection

m_OutText

protected javax.swing.JTextArea m_OutText

The output area for associations

m_Log

protected Logger m_Log

The destination for log/status messages

m_SaveOut

protected SaveBuffer m_SaveOut

The buffer saving object for saving output

m_History

protected ResultHistoryPanel m_History

A panel controlling results viewing

m_StartBut

protected javax.swing.JButton m_StartBut

Click to start running the associator

m_StopBut

protected javax.swing.JButton m_StopBut

Click to stop a running associator

m_storeOutput

protected javax.swing.JCheckBox m_storeOutput

Whether to store any graph or xml rules output in the history list

m_Instances

protected Instances m_Instances

The main set of instances we're playing with

m_TestInstances

protected Instances m_TestInstances

The user-supplied test set (if any)

m_RunThread

protected java.lang.Thread m_RunThread

A thread that associator runs in

m_initialSettingsSet

protected boolean m_initialSettingsSet

Whether start-up settings have been applied (i.e. initial default associator to use

Constructor Detail

AssociationsPanel

public AssociationsPanel()

Creates the associator panel

Method Detail

setLog

public void setLog(Logger newLog)

Sets the Logger to receive informational messages

Specified by:

setLog in interface Explorer.LogHandler

Specified by:

setLog in interface Perspective

Overrides:

setLog in class AbstractPerspective

Parameters:

newLog - the Logger that will now get info messages

setInstances

public void setInstances(Instances inst)

Tells the panel to use a new set of instances.

Specified by:

setInstances in interface Explorer.ExplorerPanel

Specified by:

setInstances in interface Perspective

Overrides:

setInstances in class AbstractPerspective

Parameters:

inst - a set of Instances

startAssociator

protected void startAssociator()

Starts running the currently configured associator with the current settings. This is run in a separate thread, and will only start if there is no associator already running. The associator output is sent to the results history panel.

stopAssociator

protected void stopAssociator()

Stops the currently running Associator (if any).

saveBuffer

protected void saveBuffer(java.lang.String name)

Save the currently selected associator output to a file.

Parameters:

name - the name of the buffer to save

visualizeTree

protected void visualizeTree(java.lang.String dottyString,
                             java.lang.String treeName)

Pops up a TreeVisualizer for the associator from the currently selected item in the results list

Parameters:

dottyString - the description of the tree in dotty format

treeName - the title to assign to the display

historyRightClickPopup

protected void historyRightClickPopup(java.util.List<java.lang.String> names,
                                      int x,
                                      int y)

Handles constructing a popup menu with visualization options.

Parameters:

names - the names of the result history list entries clicked on by the user

x - the x coordinate for popping up the menu

y - the y coordinate for popping up the menu

updateCapabilitiesFilter

protected void updateCapabilitiesFilter(Capabilities filter)

updates the capabilities filter of the GOE

Parameters:

filter - the new filter to use

capabilitiesFilterChanged

public void capabilitiesFilterChanged(Explorer.CapabilitiesFilterChangeEvent e)

method gets called in case of a change event

Specified by:

capabilitiesFilterChanged in interface Explorer.CapabilitiesFilterChangeListener

Parameters:

e - the associated change event

setExplorer

public void setExplorer(Explorer parent)

Sets the Explorer to use as parent frame (used for sending notifications about changes in the data)

Specified by:

setExplorer in interface Explorer.ExplorerPanel

Parameters:

parent - the parent frame

getExplorer

public Explorer getExplorer()

returns the parent Explorer frame

Specified by:

getExplorer in interface Explorer.ExplorerPanel

Returns:

the parent

getTabTitle

public java.lang.String getTabTitle()

Returns the title for the tab in the Explorer

Specified by:

getTabTitle in interface Explorer.ExplorerPanel

Returns:

the title of this tab

getTabTitleToolTip

public java.lang.String getTabTitleToolTip()

Returns the tooltip for the tab in the Explorer

Specified by:

getTabTitleToolTip in interface Explorer.ExplorerPanel

Returns:

the tooltip of this tab

requiresLog

public boolean requiresLog()

Description copied from class: AbstractPerspective

Whether this perspective requires a graphical log to write to

Specified by:

requiresLog in interface Perspective

Overrides:

requiresLog in class AbstractPerspective

Returns:

true if a log is needed by this perspective

acceptsInstances

public boolean acceptsInstances()

Description copied from class: AbstractPerspective

Returns true if this perspective can do something meaningful with a set of instances

Specified by:

acceptsInstances in interface Perspective

Overrides:

acceptsInstances in class AbstractPerspective

Returns:

true if this perspective accepts instances

getDefaultSettings

public Defaults getDefaultSettings()

Description copied from class: AbstractPerspective

Get the default settings for this perspective (or null if there are none)

Specified by:

getDefaultSettings in interface Perspective

Overrides:

getDefaultSettings in class AbstractPerspective

Returns:

the default settings for this perspective, or null if the perspective does not have any settings

okToBeActive

public boolean okToBeActive()

Description copied from class: AbstractPerspective

Returns true if the perspective is usable at this time. This is a no-opp implementation that always returns true. Subclasses should override if there are specific conditions that need to be met (e.g. can't operate if there are no instances set).

Specified by:

okToBeActive in interface Perspective

Overrides:

okToBeActive in class AbstractPerspective

Returns:

true if this perspective is usable at this time

setActive

public void setActive(boolean active)

Description copied from class: AbstractPerspective

Set active status of this perspective. True indicates that this perspective is the visible active perspective in the application

Specified by:

setActive in interface Perspective

Overrides:

setActive in class AbstractPerspective

Parameters:

active - true if this perspective is the active one

settingsChanged

public void settingsChanged()

Description copied from class: AbstractPerspective

Called when the user alters settings. The settings altered by the user are not necessarily ones related to this perspective

Specified by:

settingsChanged in interface Perspective

Overrides:

settingsChanged in class AbstractPerspective

main

public static void main(java.lang.String[] args)

Tests out the Associator panel from the command line.

Parameters:

args - may optionally contain the name of a dataset to load.