adams.flow.sink
Class ZScoreDisplay

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.ZScoreDisplay

All Implemented Interfaces:

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

public class ZScoreDisplay
extends AbstractGraphicalDisplay
implements DisplayPanelProvider

Actor for displaying a z score plot

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: ZScoreDisplay
 

-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.
 

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

-height <int> (property: height)
    The height of the dialog.
    default: 500
    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
 

-overlay <adams.gui.visualization.stats.zscore.AbstractZScoreOverlay> [-overlay ...] (property: overlays)
    Add overlays to the z score plot
    default: adams.gui.visualization.stats.zscore.Mean, adams.gui.visualization.stats.zscore.StdDev -color #ffc800 -standard-deviations 2.0, adams.gui.visualization.stats.zscore.StdDev -color #ff0000 -standard-deviations 3.0
 

-paintlet <adams.gui.visualization.stats.paintlet.AbstractZScorePaintlet> (property: paintlet)
    Choose paintlet for plotting data
    default: adams.gui.visualization.stats.paintlet.ZScoreCircle
 

-attribute-name <adams.core.base.BaseRegExp> (property: attributeName)
    Name of attribute to display, used if set,otherwise the index is used
    default:
 

-attribute <java.lang.String> (property: attribute)
    Set the attribute to display using an index, used only if regular expression
    not set
    default: 1
 

Version:

$Revision: 6700 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected BaseRegExp	m_Att String for regular expression for attribute
protected String	m_AttIndex String for index to set attribute
protected AbstractZScoreOverlay[]	m_Overlays Array containing initial z score overlays
protected AbstractZScorePaintlet	m_Paintlet Paintlet to draw initial data with
protected boolean	m_ShowOptions whether to show the options in the display or not.
protected ZScore	m_ZScore zscore to display using the actor

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_ExecutionListeningSupporter, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_ScopeHandler, 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

ZScoreDisplay()

Method Summary

Class[]	accepts()
String	attributeNameTipText() Return a tip text for the attribute name property
String	attributeTipText() return a tip text for the attribute index property
void	clearPanel()
AbstractDisplayPanel	createDisplayPanel(Token token) Creates a new panel for the token.
void	defineOptions()
protected void	display(Token token)
boolean	displayPanelRequiresScrollPane() Returns whether the created display panel requires a scroll pane or not.
String	getAttribute() Get the string used to set the attribute using an index
BaseRegExp	getAttributeName() Get the string to set the attribute using a regular expression
protected int	getDefaultHeight()
protected int	getDefaultWidth()
AbstractZScoreOverlay[]	getOverlays() get the overlays to be drawn on the z score plot
AbstractZScorePaintlet	getPaintlet() Get the paintlet to be used for plotting the data
boolean	getShowOptions() Returns whether to show the options or not.
String	globalInfo()
protected BasePanel	newPanel()
String	overlaysTipText() Returns a tip text for the overlays property
String	paintletTipText() Returns a tip text for the paintlet property
void	setAttribute(String val) Set the string to use for setting the attribute using an index
void	setAttributeName(BaseRegExp val) Set the attribute to use with a regular expression
void	setOverlays(AbstractZScoreOverlay[] over) set the overlays to be drawn on the z score plot
void	setPaintlet(AbstractZScorePaintlet paintlet) Setbefore regular expression if this is provide the paintlet to be used for displaying the data
void	setShowOptions(boolean value) Sets whether to show the options panel or not.
String	showOptionsTipText() Return a tip text for the attribute name property

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, 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, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, 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.Actor

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, 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

Methods inherited from interface adams.flow.core.InputConsumer

input

Field Detail

m_ZScore

protected ZScore m_ZScore

zscore to display using the actor

m_Overlays

protected AbstractZScoreOverlay[] m_Overlays

Array containing initial z score overlays

m_Paintlet

protected AbstractZScorePaintlet m_Paintlet

Paintlet to draw initial data with

m_Att

protected BaseRegExp m_Att

String for regular expression for attribute

m_AttIndex

protected String m_AttIndex

String for index to set attribute

m_ShowOptions

protected boolean m_ShowOptions

whether to show the options in the display or not.

Constructor Detail

ZScoreDisplay

public ZScoreDisplay()

Method Detail

accepts

public Class[] accepts()

Specified by:

accepts in interface InputConsumer

defineOptions

public void defineOptions()

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractGraphicalDisplay

setAttributeName

public void setAttributeName(BaseRegExp val)

Set the attribute to use with a regular expression

Parameters:

val - String for regular expression

getAttributeName

public BaseRegExp getAttributeName()

Get the string to set the attribute using a regular expression

Returns:

String for regular expression

attributeNameTipText

public String attributeNameTipText()

Return a tip text for the attribute name property

Returns:

tip text for the property

setShowOptions

public void setShowOptions(boolean value)

Sets whether to show the options panel or not.

Parameters:

value - true if to show the options

getShowOptions

public boolean getShowOptions()

Returns whether to show the options or not.

Returns:

true if the options are shown

showOptionsTipText

public String showOptionsTipText()

Return a tip text for the attribute name property

Returns:

tip text for the property

setAttribute

public void setAttribute(String val)

Set the string to use for setting the attribute using an index

Parameters:

val - String for the attribute index

getAttribute

public String getAttribute()

Get the string used to set the attribute using an index

Returns:

String for the index

attributeTipText

public String attributeTipText()

return a tip text for the attribute index property

Returns:

tip text for the property

setOverlays

public void setOverlays(AbstractZScoreOverlay[] over)

set the overlays to be drawn on the z score plot

Parameters:

over - Array containing the overlays

getOverlays

public AbstractZScoreOverlay[] getOverlays()

get the overlays to be drawn on the z score plot

Returns:

Array containing the overlays

overlaysTipText

public String overlaysTipText()

Returns a tip text for the overlays property

Returns:

Tip text for the property

setPaintlet

public void setPaintlet(AbstractZScorePaintlet paintlet)

Setbefore regular expression if this is provide the paintlet to be used for displaying the data

Parameters:

paintlet - Paintlet to be used

getPaintlet

public AbstractZScorePaintlet getPaintlet()

Get the paintlet to be used for plotting the data

Returns:

Paintlet to be used

paintletTipText

public String paintletTipText()

Returns a tip text for the paintlet property

Returns:

Tip text for this property

getDefaultWidth

protected int getDefaultWidth()

Overrides:

getDefaultWidth in class AbstractDisplay

getDefaultHeight

protected int getDefaultHeight()

Overrides:

getDefaultHeight in class AbstractDisplay

clearPanel

public void clearPanel()

Specified by:

clearPanel in class AbstractDisplay

newPanel

protected BasePanel newPanel()

Specified by:

newPanel in class AbstractDisplay

display

protected void display(Token token)

Specified by:

display in class AbstractDisplay

createDisplayPanel

public AbstractDisplayPanel createDisplayPanel(Token token)

Creates a new panel for the token.

Specified by:

createDisplayPanel in interface DisplayPanelProvider

Parameters:

token - the token to display in a new panel

Returns:

the generated panel

displayPanelRequiresScrollPane

public boolean displayPanelRequiresScrollPane()

Returns whether the created display panel requires a scroll pane or not.

Specified by:

displayPanelRequiresScrollPane in interface DisplayPanelProvider

Returns:

true if the display panel requires a scroll pane

globalInfo

public String globalInfo()

Specified by:

globalInfo in class AbstractOptionHandler