weka.gui.beans
Class Classifier

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--weka.gui.beans.Classifier
All Implemented Interfaces:
javax.accessibility.Accessible, BeanCommon, EventConstraints, java.util.EventListener, java.awt.image.ImageObserver, InstanceListener, java.awt.MenuContainer, java.io.Serializable, TestSetListener, TrainingSetListener, UserRequestAcceptor, Visible, WekaWrapper

public class Classifier
extends javax.swing.JPanel
implements BeanCommon, Visible, WekaWrapper, EventConstraints, java.io.Serializable, UserRequestAcceptor, TrainingSetListener, TestSetListener, InstanceListener

Bean that wraps around weka.classifiers

Since:
1.0
Version:
$Revision: 1.7 $
Author:
Mark Hall
See Also:
JPanel, BeanCommon, Visible, WekaWrapper, Serializable, UserRequestAcceptor, TrainingSetListener, TestSetListener, Serialized Form

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_WINDOW
 
Fields inherited from class java.awt.Component
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
Classifier()
          Creates a new Classifier instance.
 
Method Summary
 void acceptInstance(InstanceEvent e)
          Accepts an instance for incremental processing.
 void acceptTestSet(TestSetEvent e)
          Accepts a test set for a batch trained classifier
 void acceptTrainingSet(TrainingSetEvent e)
          Accepts a training set and builds batch classifier
 void addBatchClassifierListener(BatchClassifierListener cl)
          Add a batch classifier listener
 void addGraphListener(GraphListener cl)
          Add a graph listener
 void addIncrementalClassifierListener(IncrementalClassifierListener cl)
          Add an incremental classifier listener
 void addTextListener(TextListener cl)
          Add a text listener
 boolean connectionAllowed(java.lang.String eventName)
          Returns true if, at this time, the object will accept a connection with respect to the named event
 void connectionNotification(java.lang.String eventName, java.lang.Object source)
          Notify this object that it has been registered as a listener with a source with respect to the named event
 void disconnectionNotification(java.lang.String eventName, java.lang.Object source)
          Notify this object that it has been deregistered as a listener with a source with respect to the supplied event name
 java.util.Enumeration enumerateRequests()
          Return an enumeration of requests that can be made by the user
 boolean eventGeneratable(java.beans.EventSetDescriptor esd)
          Returns true, if at the current time, the event described by the supplied event descriptor could be generated.
 boolean eventGeneratable(java.lang.String eventName)
          Returns true, if at the current time, the named event could be generated.
 Classifier getClassifier()
          Get the classifier currently set for this wrapper
 boolean getUpdateIncrementalClassifier()
           
 BeanVisual getVisual()
          Gets the visual appearance of this wrapper bean
 java.lang.Object getWrappedAlgorithm()
          Returns the wrapped classifier
 boolean hasIncomingBatchInstances()
          Returns true if this classifier has an incoming connection that is a batch set of instances
 boolean hasIncomingStreamInstances()
          Returns true if this classifier has an incoming connection that is an instance stream
 void performRequest(java.lang.String request)
          Perform a particular request
 void removeBatchClassifierListener(BatchClassifierListener cl)
          Remove a batch classifier listener
 void removeGraphListener(GraphListener cl)
          Remove a graph listener
 void removeIncrementalClassifierListener(IncrementalClassifierListener cl)
          Remove an incremental classifier listener
 void removeTextListener(TextListener cl)
          Remove a text listener
 void setClassifier(Classifier c)
          Set the classifier for this wrapper
 void setLog(Logger logger)
          Set a logger
 void setUpdateIncrementalClassifier(boolean update)
           
 void setVisual(BeanVisual newVisual)
          Sets the visual appearance of this wrapper bean
 void setWrappedAlgorithm(java.lang.Object algorithm)
          Sets the algorithm (classifier) for this bean
 void stop()
          Stop any classifier action
 void useDefaultVisual()
          Use the default visual appearance for this bean
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Classifier

public Classifier()
Creates a new Classifier instance.

Method Detail

setClassifier

public void setClassifier(Classifier c)
Set the classifier for this wrapper

Parameters:
c - a weka.classifiers.Classifier value

hasIncomingStreamInstances

public boolean hasIncomingStreamInstances()
Returns true if this classifier has an incoming connection that is an instance stream

Returns:
true if has an incoming connection that is an instance stream

hasIncomingBatchInstances

public boolean hasIncomingBatchInstances()
Returns true if this classifier has an incoming connection that is a batch set of instances

Returns:
a boolean value

getClassifier

public Classifier getClassifier()
Get the classifier currently set for this wrapper

Returns:
a weka.classifiers.Classifier value

setWrappedAlgorithm

public void setWrappedAlgorithm(java.lang.Object algorithm)
Sets the algorithm (classifier) for this bean

Specified by:
setWrappedAlgorithm in interface WekaWrapper
Parameters:
algorithm - an Object value
Throws:
java.lang.IllegalArgumentException - if an error occurs

getWrappedAlgorithm

public java.lang.Object getWrappedAlgorithm()
Returns the wrapped classifier

Specified by:
getWrappedAlgorithm in interface WekaWrapper
Returns:
an Object value

getUpdateIncrementalClassifier

public boolean getUpdateIncrementalClassifier()

setUpdateIncrementalClassifier

public void setUpdateIncrementalClassifier(boolean update)

acceptInstance

public void acceptInstance(InstanceEvent e)
Accepts an instance for incremental processing.

Specified by:
acceptInstance in interface InstanceListener
Parameters:
e - an InstanceEvent value

acceptTrainingSet

public void acceptTrainingSet(TrainingSetEvent e)
Accepts a training set and builds batch classifier

Specified by:
acceptTrainingSet in interface TrainingSetListener
Parameters:
e - a TrainingSetEvent value

acceptTestSet

public void acceptTestSet(TestSetEvent e)
Accepts a test set for a batch trained classifier

Specified by:
acceptTestSet in interface TestSetListener
Parameters:
e - a TestSetEvent value

setVisual

public void setVisual(BeanVisual newVisual)
Sets the visual appearance of this wrapper bean

Specified by:
setVisual in interface Visible
Parameters:
newVisual - a BeanVisual value

getVisual

public BeanVisual getVisual()
Gets the visual appearance of this wrapper bean

Specified by:
getVisual in interface Visible
Returns:
a BeanVisual value

useDefaultVisual

public void useDefaultVisual()
Use the default visual appearance for this bean

Specified by:
useDefaultVisual in interface Visible

addBatchClassifierListener

public void addBatchClassifierListener(BatchClassifierListener cl)
Add a batch classifier listener

Parameters:
cl - a BatchClassifierListener value

removeBatchClassifierListener

public void removeBatchClassifierListener(BatchClassifierListener cl)
Remove a batch classifier listener

Parameters:
cl - a BatchClassifierListener value

addGraphListener

public void addGraphListener(GraphListener cl)
Add a graph listener

Parameters:
cl - a GraphListener value

removeGraphListener

public void removeGraphListener(GraphListener cl)
Remove a graph listener

Parameters:
cl - a GraphListener value

addTextListener

public void addTextListener(TextListener cl)
Add a text listener

Parameters:
cl - a TextListener value

removeTextListener

public void removeTextListener(TextListener cl)
Remove a text listener

Parameters:
cl - a TextListener value

addIncrementalClassifierListener

public void addIncrementalClassifierListener(IncrementalClassifierListener cl)
Add an incremental classifier listener

Parameters:
cl - an IncrementalClassifierListener value

removeIncrementalClassifierListener

public void removeIncrementalClassifierListener(IncrementalClassifierListener cl)
Remove an incremental classifier listener

Parameters:
cl - an IncrementalClassifierListener value

connectionAllowed

public boolean connectionAllowed(java.lang.String eventName)
Returns true if, at this time, the object will accept a connection with respect to the named event

Specified by:
connectionAllowed in interface BeanCommon
Parameters:
eventName - the event
Returns:
true if the object will accept a connection

connectionNotification

public void connectionNotification(java.lang.String eventName,
                                   java.lang.Object source)
Notify this object that it has been registered as a listener with a source with respect to the named event

Specified by:
connectionNotification in interface BeanCommon
Parameters:
eventName - the event
source - the source with which this object has been registered as a listener

disconnectionNotification

public void disconnectionNotification(java.lang.String eventName,
                                      java.lang.Object source)
Notify this object that it has been deregistered as a listener with a source with respect to the supplied event name

Specified by:
disconnectionNotification in interface BeanCommon
Parameters:
eventName - the event
source - the source with which this object has been registered as a listener

stop

public void stop()
Stop any classifier action

Specified by:
stop in interface BeanCommon

setLog

public void setLog(Logger logger)
Set a logger

Specified by:
setLog in interface BeanCommon
Parameters:
logger - a Logger value

enumerateRequests

public java.util.Enumeration enumerateRequests()
Return an enumeration of requests that can be made by the user

Specified by:
enumerateRequests in interface UserRequestAcceptor
Returns:
an Enumeration value

performRequest

public void performRequest(java.lang.String request)
Perform a particular request

Specified by:
performRequest in interface UserRequestAcceptor
Parameters:
request - the request to perform
Throws:
java.lang.IllegalArgumentException - if an error occurs

eventGeneratable

public boolean eventGeneratable(java.beans.EventSetDescriptor esd)
Returns true, if at the current time, the event described by the supplied event descriptor could be generated.

Parameters:
esd - an EventSetDescriptor value
Returns:
a boolean value

eventGeneratable

public boolean eventGeneratable(java.lang.String eventName)
Returns true, if at the current time, the named event could be generated. Assumes that the supplied event name is an event that could be generated by this bean

Specified by:
eventGeneratable in interface EventConstraints
Parameters:
eventName - the name of the event in question
Returns:
true if the named event could be generated at this point in time


Copyright (c) 2003 David Lindsay, Computer Learning Research Centre, Dept. Computer Science, Royal Holloway, University of London