weka.gui.beans

Class TimeSeriesForecasting

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

weka.gui.beans.TimeSeriesForecasting

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, weka.core.EnvironmentHandler, weka.gui.beans.BeanCommon, weka.gui.beans.DataSourceListener, weka.gui.beans.EventConstraints, weka.gui.beans.InstanceListener, weka.gui.beans.Visible

@KFStep(category="Time Series",
        toolTipText="Forecasting using a time series model")
public class TimeSeriesForecasting
extends JPanel
implements weka.gui.beans.BeanCommon, weka.gui.beans.Visible, weka.gui.beans.EventConstraints, weka.core.EnvironmentHandler, weka.gui.beans.InstanceListener, weka.gui.beans.DataSourceListener

KnowledgeFlow component for producing a forecast using a time series forecasting model.

Version:

$Revision: 52593 $

Author:

Mark hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

Nested 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_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

Constructors

Constructor and Description
TimeSeriesForecasting() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptDataSet(weka.gui.beans.DataSetEvent dse) Accept an incoming data set
void	acceptInstance(weka.gui.beans.InstanceEvent e) Accept an incoming instance
void	addInstanceListener(weka.gui.beans.InstanceListener l) Add an listener to be notified of outgoing InstanceEvents
boolean	connectionAllowed(EventSetDescriptor esd) Returns true if, at this time, the object will accept a connection according to the supplied EventSetDescriptor
boolean	connectionAllowed(String eventName) Returns true if, at this time, the object will accept a connection with respect to the named event
void	connectionNotification(String eventName, Object source) Notify this object that it has been registered as a listener with a source with respect to the named event
void	disconnectionNotification(String eventName, Object source) Notify this object that it has been deregistered as a listener with a source with respect to the supplied event name
static String	encodeForecasterToBase64(WekaForecaster model, weka.core.Instances header) Encode the model and header into a base 64 string.
boolean	eventGeneratable(String eventName) Returns true, if at the current time, the named event could be generated.
String	getArtificialTimeStartOffset() Get the offset, from the value associated with the last training instance, for the artificial time stamp.
String	getCustomName() Get the custom (descriptive) name for this bean (if one has been set)
String	getEncodedForecaster() Gets the base 64 encoded forecaster
String	getFilename() Get the filename to load from.
WekaForecaster	getForecaster() Get the forecaster.
static List<Object>	getForecaster(String base64encoded) Decodes and returns a forecasting model (list containing the forecaster and Instances object containing the structure of the data used to train the forecaster) from a base 64 string.
String	getNumStepsToForecast() Get the number of time steps to forecast beyond the end of the incoming priming data.
boolean	getRebuildForecaster() Get whether the forecaster will be rebuilt/re-estimated on the incoming data.
String	getSaveFilename() Get the name of the file to save the forecasting model to if the user has opted to rebuild the forecaster using the incoming data.
weka.gui.beans.BeanVisual	getVisual() Gets the visual appearance of this wrapper bean
String	globalInfo() Global about information for this component.
boolean	isBusy() Returns true if.
void	removeInstanceListener(weka.gui.beans.InstanceListener l) Deregister and remove a listener of InstanceEvents
void	setArtificialTimeStartOffset(String art) Set the offset, from the value associated with the last training instance, for the artificial time stamp.
void	setCustomName(String name) Set a custom (descriptive) name for this bean
void	setEncodedForecaster(String encodedForecaster) Set the base 64 encoded forecaster.
void	setEnvironment(weka.core.Environment env) Set environment variables to use.
void	setFilename(String filename) Set the filename to load from.
void	setLog(weka.gui.Logger logger) Set the logging object to use
void	setNumStepsToForecast(String n) Set the number of time steps to forecast beyond the end of the incoming priming data.
void	setRebuildForecaster(boolean rebuild) Set whether the forecaster should be rebuilt/re-estimated on the incoming data.
void	setSaveFilename(String fileName) Set the name of the file to save the forecasting model out to if the user has opted to rebuild the forecaster using the incoming data.
void	setVisual(weka.gui.beans.BeanVisual newVisual) Sets the visual appearance of this wrapper bean
void	stop() Stop the component from executing.
void	useDefaultVisual() Use the default images for a data source

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods 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, update

Methods 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, 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, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeSeriesForecasting

public TimeSeriesForecasting()

Constructor

Method Detail

globalInfo

public String globalInfo()

Global about information for this component.

Returns:

global information for this component

useDefaultVisual

public void useDefaultVisual()

Use the default images for a data source

Specified by:

useDefaultVisual in interface weka.gui.beans.Visible

setLog

public void setLog(weka.gui.Logger logger)

Set the logging object to use

Specified by:

setLog in interface weka.gui.beans.BeanCommon

Parameters:

logger - the logging object to use

getForecaster

public WekaForecaster getForecaster()
                             throws Exception

Get the forecaster. Loads the forecaster from a file (if necessary).

Returns:

the forecasting model

Throws:

Exception - if there is a problem loading the forecaster

getForecaster

public static List<Object> getForecaster(String base64encoded)
                                  throws Exception

Decodes and returns a forecasting model (list containing the forecaster and Instances object containing the structure of the data used to train the forecaster) from a base 64 string.

Parameters:

base64encoded - a List