java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.tools.previewbrowser.AbstractContentHandler
      - adams.gui.tools.previewbrowser.ActualVsPredictedHandler

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ContentHandler, Serializable
```
public class ActualVsPredictedHandler
extends AbstractContentHandler
```
For displaying an actual vs predicted plot.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected SpreadSheetColumnIndex`	`m_Actual`	the column with the actual values.
`protected SpreadSheetColumnRange`	`m_Additional`	the additional columns in the spreadsheet to add to the plot containers.
`protected SpreadSheetColumnIndex`	`m_Error`	the column with the error values (optional).
`protected SpreadSheetColumnIndex`	`m_Predicted`	the column with the predicted values.
`protected boolean`	`m_SwapAxes`	whether to swap the axes.

Fields inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler
m_Relation

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.gui.tools.previewbrowser.ContentHandler
MATCH_ALL

Constructor Summary

Constructors
Constructor Description

ActualVsPredictedHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`actualTipText()`	Returns the tip text for this property.
`String`	`additionalTipText()`	Returns the tip text for this property.
`PreviewPanel`	`createPreview(File file)`	Creates the actual preview.
`void`	`defineOptions()`	Adds options to the internal list of options.
`String`	`errorTipText()`	Returns the tip text for this property.
`SpreadSheetColumnIndex`	`getActual()`	Returns the column with the actual values.
`SpreadSheetColumnRange`	`getAdditional()`	Returns the additional columns to add to the plot containers.
`SpreadSheetColumnIndex`	`getError()`	Returns the column with the error values.
`String[]`	`getExtensions()`	Returns the list of extensions (without dot) that this handler can take care of.
`SpreadSheetColumnIndex`	`getPredicted()`	Returns the column with the predicted values.
`boolean`	`getSwapAxes()`	Returns whether to swap the axes.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`predictedTipText()`	Returns the tip text for this property.
`void`	`setActual(SpreadSheetColumnIndex value)`	Sets the column with the actual values.
`void`	`setAdditional(SpreadSheetColumnRange value)`	Sets the additional columns to add to the plot containers.
`void`	`setError(SpreadSheetColumnIndex value)`	Sets the column with the error values.
`void`	`setPredicted(SpreadSheetColumnIndex value)`	Sets the column with the predicted values.
`void`	`setSwapAxes(boolean value)`	Sets whether to swap the axes.
`String`	`swapAxesTipText()`	Returns the tip text for this property.

Methods inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler
checkFile, getHandlers, getHandlersForFile, getHandlersForFile, getPreview, getRelation, hasHandler, hasHandler, reusePreview

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

- Field Detail
  - m_Actual
```
protected SpreadSheetColumnIndex m_Actual
```
    the column with the actual values.
  - m_Predicted
```
protected SpreadSheetColumnIndex m_Predicted
```
    the column with the predicted values.
  - m_Error
```
protected SpreadSheetColumnIndex m_Error
```
    the column with the error values (optional).
  - m_Additional
```
protected SpreadSheetColumnRange m_Additional
```
    the additional columns in the spreadsheet to add to the plot containers.
  - m_SwapAxes
```
protected boolean m_SwapAxes
```
    whether to swap the axes.
- Constructor Detail
  - ActualVsPredictedHandler
```
public ActualVsPredictedHandler()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    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 options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setActual
```
public void setActual(SpreadSheetColumnIndex value)
```
    Sets the column with the actual values.
    
    Parameters:
    
    value - the column
  - getActual
```
public SpreadSheetColumnIndex getActual()
```
    Returns the column with the actual values.
    
    Returns:
    
    the range
  - actualTipText
```
public String actualTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setPredicted
```
public void setPredicted(SpreadSheetColumnIndex value)
```
    Sets the column with the predicted values.
    
    Parameters:
    
    value - the column
  - getPredicted
```
public SpreadSheetColumnIndex getPredicted()
```
    Returns the column with the predicted values.
    
    Returns:
    
    the range
  - predictedTipText
```
public String predictedTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setError
```
public void setError(SpreadSheetColumnIndex value)
```
    Sets the column with the error values.
    
    Parameters:
    
    value - the column
  - getError
```
public SpreadSheetColumnIndex getError()
```
    Returns the column with the error values.
    
    Returns:
    
    the column
  - errorTipText
```
public String errorTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAdditional
```
public void setAdditional(SpreadSheetColumnRange value)
```
    Sets the additional columns to add to the plot containers.
    
    Parameters:
    
    value - the columns
  - getAdditional
```
public SpreadSheetColumnRange getAdditional()
```
    Returns the additional columns to add to the plot containers.
    
    Returns:
    
    the columns
  - additionalTipText
```
public String additionalTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setSwapAxes
```
public void setSwapAxes(boolean value)
```
    Sets whether to swap the axes.
    
    Parameters:
    
    value - true if to swap
  - getSwapAxes
```
public boolean getSwapAxes()
```
    Returns whether to swap the axes.
    
    Returns:
    
    true if to swap
  - swapAxesTipText
```
public String swapAxesTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getExtensions
```
public String[] getExtensions()
```
    Returns the list of extensions (without dot) that this handler can take care of.
    
    Returns:
    
    the list of extensions (no dot)
  - createPreview
```
public PreviewPanel createPreview(File file)
```
    Creates the actual preview.
    
    Specified by:
    
    createPreview in interface ContentHandler
    
    Specified by:
    
    createPreview in class AbstractContentHandler
    
    Parameters:
    
    file - the file to create the view for
    
    Returns:
    
    the preview

Class ActualVsPredictedHandler

Field Summary

Fields inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Fields inherited from interface adams.gui.tools.previewbrowser.ContentHandler

Constructor Summary

Method Summary

Methods inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.Destroyable

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.option.OptionHandler

Field Detail

m_Actual

m_Predicted

m_Error

m_Additional

m_SwapAxes

Constructor Detail

ActualVsPredictedHandler

Method Detail

globalInfo

defineOptions

setActual

getActual

actualTipText

setPredicted

getPredicted

predictedTipText

setError

getError

errorTipText

setAdditional

getAdditional

additionalTipText

setSwapAxes

getSwapAxes

swapAxesTipText

getExtensions

createPreview