adams.flow.sink
Class Histogram

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.core.AbstractDisplay
                  adams.flow.sink.AbstractDisplay
                      adams.flow.sink.AbstractGraphicalDisplay
                          adams.flow.sink.Histogram

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, InputConsumer, ComponentSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

public class Histogram
extends AbstractGraphicalDisplay

Generates a histogram based on the incoming data.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: Histogram
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-short-title (property: shortTitle)
    If enabled uses just the name for the title instead of the actor's full 
    name.
 

-width <int> (property: width)
    The width of the dialog.
    default: 800
    minimum: -1
 

-height <int> (property: height)
    The height of the dialog.
    default: 600
    minimum: -1
 

-x <int> (property: x)
    The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
    ).
    default: -1
    minimum: -3
 

-y <int> (property: y)
    The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -1
    minimum: -3
 

-writer <adams.gui.print.JComponentWriter> (property: writer)
    The writer to use for generating the graphics output.
    default: adams.gui.print.NullWriter
 

-index <adams.core.Index> (property: index)
    The attribute index in case of Instances being displayed.
    default: first
 

-options <adams.gui.visualization.stats.histogram.HistogramOptions> (property: options)
    The display options for the histogram.
    default: adams.gui.visualization.stats.histogram.HistogramOptions -paintlet adams.gui.visualization.stats.paintlet.HistogramPaintlet
 

Version:

$Revision: 6338 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected String	m_DataName the name for the data.
protected Index	m_Index the attribute index, in case of Instances.
protected HistogramOptions	m_Options the histogram options themselves.

Fields inherited from class adams.flow.sink.AbstractGraphicalDisplay

m_GraphicFileChooser, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs, m_MenuItemFileSaveTextAs, m_TextFileChooser, m_Writer

Fields inherited from class adams.flow.core.AbstractDisplay

BACKUP_INPUT, m_CreateFrame, m_Frame, m_Height, m_InputToken, m_Panel, m_ShortTitle, m_Updating, m_Width, m_X, m_Y

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Histogram()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
void	clearPanel() Clears the content of the panel.
String	dataNameTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of operations
protected void	display(Token token) Displays the token (the panel and dialog have already been created at this stage).
String	getDataName() Returns the attirbute index in case of Instances data.
Index	getIndex() Returns the attirbute index in case of Instances data.
HistogramOptions	getOptions() Returns the display options
String	globalInfo() Returns a string describing the object.
String	indexTipText() Returns the tip text for this property.
protected BasePanel	newPanel() Creates the panel to display in the dialog.
String	optionsTipText() Returns the tip text for this property.
void	setDataName(String value) Sets the attribute index in case of Instances data.
void	setIndex(Index value) Sets the attribute index in case of Instances data.
void	setOptions(HistogramOptions value) Sets the display options.

Methods inherited from class adams.flow.sink.AbstractGraphicalDisplay

cleanUpGUI, clear, close, createMenuBar, getGraphicFileChooser, getMenuBar, getSendToClasses, getSendToItem, getTextFileChooser, getWriter, hasPanel, hasSendToItem, postDisplay, preDisplay, saveAs, saveTextAs, setWriter, supplyComponent, supportsClear, updateMenu, writerTipText

Methods inherited from class adams.flow.sink.AbstractDisplay

newDisplayRunnable

Methods inherited from class adams.flow.core.AbstractDisplay

backupState, cleanUp, createFrame, createTitle, doCreateFrame, doExecute, getCreateFrame, getDefaultHeight, getDefaultWidth, getDefaultX, getDefaultY, getFrame, getHeight, getPanel, getQuickInfo, getShortTitle, getWidth, getX, getY, heightTipText, initialize, input, postCreateFrame, preCreateFrame, reset, restoreState, setCreateFrame, setHeight, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, widthTipText, wrapUp, xTipText, yTipText

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.core.InputConsumer

input

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getQuickInfo, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Index

protected Index m_Index

the attribute index, in case of Instances.

m_DataName

protected String m_DataName

the name for the data.

m_Options

protected HistogramOptions m_Options

the histogram options themselves.

Constructor Detail

Histogram

public Histogram()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of operations

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractGraphicalDisplay

setIndex

public void setIndex(Index value)

Sets the attribute index in case of Instances data.

Parameters:

value - the index

getIndex

public Index getIndex()

Returns the attirbute index in case of Instances data.

Returns:

the index

indexTipText

public String indexTipText()

Returns the tip text for this property.

Returns:

tip text for this property

setDataName

public void setDataName(String value)

Sets the attribute index in case of Instances data.

Parameters:

value - the index

getDataName

public String getDataName()

Returns the attirbute index in case of Instances data.

Returns:

the index

dataNameTipText

public String dataNameTipText()

Returns the tip text for this property.

Returns:

tip text for this property

setOptions

public void setOptions(HistogramOptions value)

Sets the display options.

Parameters:

value - the options

getOptions

public HistogramOptions getOptions()

Returns the display options

Returns:

the options

optionsTipText

public String optionsTipText()

Returns the tip text for this property.

Returns:

tip text for this property

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

the Class of objects that can be processed

display

protected void display(Token token)

Displays the token (the panel and dialog have already been created at this stage).

Specified by:

display in class AbstractDisplay

Parameters:

token - the token to display

clearPanel

public void clearPanel()

Clears the content of the panel.

Specified by:

clearPanel in class AbstractDisplay

newPanel

protected BasePanel newPanel()

Creates the panel to display in the dialog.

Specified by:

newPanel in class AbstractDisplay

Returns:

the panel