Package adams.flow.sink
Class ScatterDisplay
-
- All Implemented Interfaces:
AdditionalInformationHandler
,CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter<Actor>
,SizeOfHandler
,Stoppable
,StoppableWithFeedback
,TextSupporter
,VariablesInspectionHandler
,SpreadSheetSupporter
,VariableChangeListener
,Actor
,ClearableDisplay
,DisplayTypeSupporter
,ErrorHandler
,InputConsumer
,ComponentSupplier
,DisplayPanelProvider
,TextSupplier
,MenuBarProvider
,SendToActionSupporter
,Serializable
,Comparable
public class ScatterDisplay extends AbstractGraphicalDisplay implements DisplayPanelProvider, TextSupplier, SpreadSheetSupporter
Actor for displaying a scatter plot of one attribute vs another.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-name <java.lang.String> (property: name) The name of the actor. default: ScatterDisplay
-annotation <adams.core.base.BaseAnnotation> (property: annotations) The annotations to attach to this actor. default:
-skip <boolean> (property: skip) If set to true, transformation is skipped and the input token is just forwarded as it is. default: false
-stop-flow-on-error <boolean> (property: stopFlowOnError) If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors. default: false
-silent <boolean> (property: silent) If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well. default: false
-short-title <boolean> (property: shortTitle) If enabled uses just the name for the title instead of the actor's full name. default: false
-display-in-editor <boolean> (property: displayInEditor) If enabled displays the panel in a tab in the flow editor rather than in a separate frame. default: false
-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
-x-attribute-name <adams.core.base.BaseRegExp> (property: xAttributeName) Attribute for x axis using regular expression used if set, otherwise the index is used default:
-y-attribute-name <adams.core.base.BaseRegExp> (property: yAttributeName) Attribute for y axis using regular expression used if set,otherwise the index is used default:
-color-attribute-name <adams.core.base.BaseRegExp> (property: colorAttributeName) Attribute for the colors using regular expression used if set,otherwise the index is used default:
-x-attribute <java.lang.String> (property: xAttribute) Index of attribute to display on x axis, used onlyif regular expression not set default: 1
-y-attribute <java.lang.String> (property: yAttribute) index of attribute to display on y axis, used only ifregular expression not set default: 1
-color-attribute <java.lang.String> (property: colorAttribute) index of optional attribute to use for coloring, used only ifregular expression not set, ignored if empty default:
-overlay <adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay> [-overlay ...] (property: overlays) add overlays to the scatterplot default:
-paintlet <adams.gui.visualization.stats.paintlet.AbstractScatterPlotPaintlet> (property: paintlet) Paintlet for plotting data default: adams.gui.visualization.stats.paintlet.ScatterPaintletCircle -color-provider adams.gui.visualization.core.DefaultColorProvider
-mouse-click-action <adams.gui.visualization.stats.scatterplot.action.MouseClickAction> (property: mouseClickAction) How to process mouse clicks in the plot. default: adams.gui.visualization.stats.scatterplot.action.NullClickAction
- Author:
- msf8, FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected String
m_ColorAttribute
the 1-based index of the color attribute.protected BaseRegExp
m_ColorAttributeName
String for setting color attribute using regular expressionprotected MouseClickAction
m_MouseClickAction
the mouse click action.protected AbstractScatterPlotOverlay[]
m_Overlays
Array containing scatter plot overlaysprotected AbstractScatterPlotPaintlet
m_Paintlet
Paintlet to draw original data withprotected ScatterPlot
m_ScatterPlot
scatter panel to display using the actorprotected String
m_XAttribute
the 0-based index of the X attribute.protected BaseRegExp
m_XAttributeName
String for setting x attribute using regular expressionprotected String
m_YAttribute
the 1-based index of the Y attribute.protected BaseRegExp
m_YAttributeName
String for setting y attribute using regular expression-
Fields inherited from class adams.flow.sink.AbstractGraphicalDisplay
m_GraphicFileChooser, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs, m_MenuItemFileSaveTextAs, m_MenuItemFlowPauseResume, m_MenuItemFlowStop, m_ShowFlowControlSubMenu, m_TextFileChooser, m_Writer
-
Fields inherited from class adams.flow.core.AbstractDisplay
BACKUP_INPUT, m_CreateFrame, m_DisplayType, m_Frame, m_Height, m_InputToken, m_KeepOpen, 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_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
Fields inherited from interface adams.flow.core.Actor
FILE_EXTENSION, FILE_EXTENSION_GZ
-
-
Constructor Summary
Constructors Constructor Description ScatterDisplay()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class[]
accepts()
Returns the class that the consumer accepts.void
clearPanel()
Clears the content of the panel.String
colorAttributeNameTipText()
Tip text to display for y attribute regular expression.String
colorAttributeTipText()
Returns the tip text setting the color attribute using an index.DisplayPanel
createDisplayPanel(Token token)
Creates a new display panel for the token.void
defineOptions()
Adds options to the internal list of options.protected void
display(Token token)
Displays the token (the panel and dialog have already been created at this stage).boolean
displayPanelRequiresScrollPane()
Returns whether the created display panel requires a scroll pane or not.String
getColorAttribute()
Get the index of the attribute displayed on the y axisBaseRegExp
getColorAttributeName()
Returns the attribute to be uses for determining the colors.String
getCustomSupplyTextMenuItemCaption()
Returns the text for the menu item.ExtensionFileFilter
getCustomTextFileFilter()
Returns a custom file filter for the file chooser.protected int
getDefaultHeight()
Returns the default height for the dialog.protected int
getDefaultWidth()
Returns the default width for the dialog.MouseClickAction
getMouseClickAction()
Returns the mouse click action in use.AbstractScatterPlotOverlay[]
getOverlays()
Get the overlays to be drawn on the scatter plotAbstractScatterPlotPaintlet
getPaintlet()
get the paintlet used to draw the data withString
getXAttribute()
Get the index of the attribute displayed on the x axisBaseRegExp
getXAttributeName()
Returns the regular expression for the attribute to be displayed on the x axisString
getYAttribute()
Get the index of the attribute displayed on the y axisBaseRegExp
getYAttributeName()
Returns the attribute to be displayed on the y axisString
globalInfo()
Returns a string describing the object.String
mouseClickActionTipText()
Returns the tip text setting the y attribute using an indexprotected BasePanel
newPanel()
Creates the panel to display in the dialog.String
overlaysTipText()
Returns the tip text for the overlays property.String
paintletTipText()
Returns the tip text for the paintlet propertyvoid
setColorAttribute(String val)
Set the attribute to use for coloring the plot (optional).void
setColorAttributeName(BaseRegExp val)
Set the color attribute on the scatter plot using a regular expression.void
setMouseClickAction(MouseClickAction value)
Sets the mouse click action to use.void
setOverlays(AbstractScatterPlotOverlay[] over)
Set the overlays to be drawn on the scatter plotvoid
setPaintlet(AbstractScatterPlotPaintlet pain)
Set the paintlet to draw the data points withvoid
setXAttribute(String val)
Sets the index of the attribute to display on x axisvoid
setXAttributeName(BaseRegExp val)
Set the x attribute on the scatter plot using a regular expressionvoid
setYAttribute(String val)
Set the attribute to be displayed on the y axis using an indexvoid
setYAttributeName(BaseRegExp val)
Set the y attribute on the scatter plot using a regular expressionString
supplyText()
Supplies the text.boolean
supportsClear()
Whether "clear" is supported and shows up in the menu.SpreadSheet
toSpreadSheet()
Returns the content as spreadsheet.String
xAttributeNameTipText()
Tip text to display for x attribute regular expressionString
xAttributeTipText()
Returns the tip text for x attribute set using index.String
yAttributeNameTipText()
Tip text to display for y attribute regular expressionString
yAttributeTipText()
Returns the tip text setting the y attribute using an index-
Methods inherited from class adams.flow.sink.AbstractGraphicalDisplay
canPauseOrResume, cleanUpGUI, clear, close, createMenuBar, getGraphicFileChooser, getMenuBar, getSendToClasses, getSendToItem, getShowFlowControlSubMenu, getTextFileChooser, getWriter, hasPanel, hasSendToItem, isPaused, pauseResumeFlow, saveAs, saveTextAs, setShowFlowControlSubMenu, setWriter, showFlowControlSubMenuTipText, stopFlow, supplyComponent, updateMenu, wrapUp, writerTipText
-
Methods inherited from class adams.flow.sink.AbstractDisplay
newDisplayRunnable, postDisplay, preDisplay
-
Methods inherited from class adams.flow.core.AbstractDisplay
backupState, cleanUp, cleanUpGUIKeepOpen, closeFrame, createFrame, createTitle, currentInput, deregisterInWrapUp, deregisterWindow, deregisterWithEditor, displayTypeTipText, doCreateFrame, doExecute, getCreateFrame, getDefaultDisplayType, getDefaultShortTitle, getDefaultX, getDefaultY, getDisplayType, getFrame, getFrameDefaultCloseOperation, getHeight, getKeepOpen, getPanel, getQuickInfo, getShortTitle, getWidth, getX, getY, hasInput, heightTipText, initialize, input, postCreateFrame, preCreateFrame, registerWindow, registerWithEditor, reset, restoreState, setCreateFrame, setDisplayType, setHeight, setKeepOpen, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, widthTipText, xTipText, yTipText
-
Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled
-
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, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp
-
Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation
-
Methods inherited from interface adams.flow.core.InputConsumer
currentInput, hasInput, input
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel
-
Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager
-
Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions
-
-
-
-
Field Detail
-
m_XAttributeName
protected BaseRegExp m_XAttributeName
String for setting x attribute using regular expression
-
m_YAttributeName
protected BaseRegExp m_YAttributeName
String for setting y attribute using regular expression
-
m_ColorAttributeName
protected BaseRegExp m_ColorAttributeName
String for setting color attribute using regular expression
-
m_XAttribute
protected String m_XAttribute
the 0-based index of the X attribute.
-
m_YAttribute
protected String m_YAttribute
the 1-based index of the Y attribute.
-
m_ColorAttribute
protected String m_ColorAttribute
the 1-based index of the color attribute.
-
m_ScatterPlot
protected ScatterPlot m_ScatterPlot
scatter panel to display using the actor
-
m_Overlays
protected AbstractScatterPlotOverlay[] m_Overlays
Array containing scatter plot overlays
-
m_Paintlet
protected AbstractScatterPlotPaintlet m_Paintlet
Paintlet to draw original data with
-
m_MouseClickAction
protected MouseClickAction m_MouseClickAction
the mouse click action.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractGraphicalDisplay
-
getDefaultWidth
protected int getDefaultWidth()
Returns the default width for the dialog.- Overrides:
getDefaultWidth
in classAbstractDisplay
- Returns:
- the default width
-
getDefaultHeight
protected int getDefaultHeight()
Returns the default height for the dialog.- Overrides:
getDefaultHeight
in classAbstractDisplay
- Returns:
- the default height
-
setOverlays
public void setOverlays(AbstractScatterPlotOverlay[] over)
Set the overlays to be drawn on the scatter plot- Parameters:
over
- Array containing overlays
-
getOverlays
public AbstractScatterPlotOverlay[] getOverlays()
Get the overlays to be drawn on the scatter plot- Returns:
- Array containing the overlays
-
overlaysTipText
public String overlaysTipText()
Returns the tip text for the overlays property.- Returns:
- tip text for this property
-
setPaintlet
public void setPaintlet(AbstractScatterPlotPaintlet pain)
Set the paintlet to draw the data points with- Parameters:
pain
- paintlet used
-
getPaintlet
public AbstractScatterPlotPaintlet getPaintlet()
get the paintlet used to draw the data with- Returns:
- Paintlet used
-
paintletTipText
public String paintletTipText()
Returns the tip text for the paintlet property- Returns:
- tip text for this property
-
setXAttributeName
public void setXAttributeName(BaseRegExp val)
Set the x attribute on the scatter plot using a regular expression- Parameters:
val
- name of attribute for axis
-
getXAttributeName
public BaseRegExp getXAttributeName()
Returns the regular expression for the attribute to be displayed on the x axis- Returns:
- name of attribute
-
xAttributeNameTipText
public String xAttributeNameTipText()
Tip text to display for x attribute regular expression- Returns:
- String to display
-
setYAttributeName
public void setYAttributeName(BaseRegExp val)
Set the y attribute on the scatter plot using a regular expression- Parameters:
val
- regular expression for attribute on y axis
-
getYAttributeName
public BaseRegExp getYAttributeName()
Returns the attribute to be displayed on the y axis- Returns:
- regular expression for choosing attribute
-
yAttributeNameTipText
public String yAttributeNameTipText()
Tip text to display for y attribute regular expression- Returns:
- String to display
-
setColorAttributeName
public void setColorAttributeName(BaseRegExp val)
Set the color attribute on the scatter plot using a regular expression.- Parameters:
val
- regular expression for color attribute
-
getColorAttributeName
public BaseRegExp getColorAttributeName()
Returns the attribute to be uses for determining the colors.- Returns:
- regular expression for choosing attribute
-
colorAttributeNameTipText
public String colorAttributeNameTipText()
Tip text to display for y attribute regular expression.- Returns:
- String to display
-
setXAttribute
public void setXAttribute(String val)
Sets the index of the attribute to display on x axis- Parameters:
val
- 1-based index of attribute for x axis
-
getXAttribute
public String getXAttribute()
Get the index of the attribute displayed on the x axis- Returns:
- 1-based index of attribute to be displayed
-
xAttributeTipText
public String xAttributeTipText()
Returns the tip text for x attribute set using index.- Returns:
- Set the attribute to be used for the x axis using a 1-based index
-
setYAttribute
public void setYAttribute(String val)
Set the attribute to be displayed on the y axis using an index- Parameters:
val
- 1-based index of attribute to be displayed on y axis
-
getYAttribute
public String getYAttribute()
Get the index of the attribute displayed on the y axis- Returns:
- The 1-based index of the attribute on the y axis
-
yAttributeTipText
public String yAttributeTipText()
Returns the tip text setting the y attribute using an index- Returns:
- 1-based index for attribute to display on y axis
-
setColorAttribute
public void setColorAttribute(String val)
Set the attribute to use for coloring the plot (optional).- Parameters:
val
- 1-based index of attribute
-
getColorAttribute
public String getColorAttribute()
Get the index of the attribute displayed on the y axis- Returns:
- The 1-based index of the attribute on the y axis
-
colorAttributeTipText
public String colorAttributeTipText()
Returns the tip text setting the color attribute using an index.- Returns:
- 1-based index for attribute
-
setMouseClickAction
public void setMouseClickAction(MouseClickAction value)
Sets the mouse click action to use.- Parameters:
value
- the action
-
getMouseClickAction
public MouseClickAction getMouseClickAction()
Returns the mouse click action in use.- Returns:
- the action, null if non set
-
mouseClickActionTipText
public String mouseClickActionTipText()
Returns the tip text setting the y attribute using an index- Returns:
- 1-based index for attribute to display on y axis
-
accepts
public Class[] accepts()
Returns the class that the consumer accepts.- Specified by:
accepts
in interfaceInputConsumer
- Returns:
- the Class of objects that can be processed
-
supportsClear
public boolean supportsClear()
Whether "clear" is supported and shows up in the menu.- Specified by:
supportsClear
in interfaceClearableDisplay
- Overrides:
supportsClear
in classAbstractGraphicalDisplay
- Returns:
- true if supported
-
clearPanel
public void clearPanel()
Clears the content of the panel.- Specified by:
clearPanel
in classAbstractDisplay
-
newPanel
protected BasePanel newPanel()
Creates the panel to display in the dialog.- Specified by:
newPanel
in classAbstractDisplay
- Returns:
- the panel
-
display
protected void display(Token token)
Displays the token (the panel and dialog have already been created at this stage).- Specified by:
display
in classAbstractDisplay
- Parameters:
token
- the token to display
-
createDisplayPanel
public DisplayPanel createDisplayPanel(Token token)
Creates a new display panel for the token.- Specified by:
createDisplayPanel
in interfaceDisplayPanelProvider
- Parameters:
token
- the token to display in a new panel, can be null- Returns:
- the generated panel
-
displayPanelRequiresScrollPane
public boolean displayPanelRequiresScrollPane()
Returns whether the created display panel requires a scroll pane or not.- Specified by:
displayPanelRequiresScrollPane
in interfaceDisplayPanelProvider
- Returns:
- true if the display panel requires a scroll pane
-
toSpreadSheet
public SpreadSheet toSpreadSheet()
Returns the content as spreadsheet.- Specified by:
toSpreadSheet
in interfaceSpreadSheetSupporter
- Returns:
- the content
-
getCustomSupplyTextMenuItemCaption
public String getCustomSupplyTextMenuItemCaption()
Returns the text for the menu item.- Specified by:
getCustomSupplyTextMenuItemCaption
in interfaceTextSupplier
- Returns:
- the menu item text, null for default
-
getCustomTextFileFilter
public ExtensionFileFilter getCustomTextFileFilter()
Returns a custom file filter for the file chooser.- Specified by:
getCustomTextFileFilter
in interfaceTextSupplier
- Returns:
- the file filter, null if to use default one
-
supplyText
public String supplyText()
Supplies the text. May get called even if actor hasn't been executed yet.- Specified by:
supplyText
in interfaceTextSupplier
- Specified by:
supplyText
in interfaceTextSupporter
- Returns:
- the text, null if none available
-
-