Renderer

java.lang.Object
- org.das2.graph.Renderer

All Implemented Interfaces:

Displayable, Editable, DataSetConsumer

Direct Known Subclasses:

BoundsRenderer, ColorSeriesRenderer, ContoursRenderer, CurveRenderer, DigitalRenderer, EventsRenderer, GraphicalLogHandler.LogRenderer, HugeScatterRenderer, MyRenderer, PitchAngleDistributionRenderer, PlotSymbolRenderer, PolarPlotRenderer, PolyMeshRenderer, RGBImageRenderer, SeriesRenderer, SpectrogramRenderer, StackedHistogramRenderer, TickCurveRenderer, VectorPlotRenderer
```
public abstract class Renderer
extends java.lang.Object
implements DataSetConsumer, Editable, Displayable
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Painter`	`bottomDecorator`
`protected DasColorBar`	`colorBar`
`protected java.lang.String`	`control` generic control string, that is handled by the renderer.
`static java.lang.String`	`CONTROL_KEY_COLOR` allocate a bunch of canonical properties.
`static java.lang.String`	`CONTROL_KEY_COLOR_TABLE`
`static java.lang.String`	`CONTROL_KEY_DRAW_ERROR`
`static java.lang.String`	`CONTROL_KEY_FILL_COLOR`
`static java.lang.String`	`CONTROL_KEY_FILL_DIRECTION`
`static java.lang.String`	`CONTROL_KEY_FILL_TEXTURE` when filling a region, use this texture (solid,hash,backhash,crosshash) to fill.
`static java.lang.String`	`CONTROL_KEY_FONT_SIZE` font size relative to the parent, so "" or "1em" is the same size.
`static java.lang.String`	`CONTROL_KEY_LINE_STYLE` used in ContoursRenderer and EventsRenderer, values like DotDashes and Solid
`static java.lang.String`	`CONTROL_KEY_LINE_THICK`
`static java.lang.String`	`CONTROL_KEY_MODULO_X`
`static java.lang.String`	`CONTROL_KEY_MODULO_Y` modulo Y indicates that a difference in 23 hours is the same as -1 hours.
`static java.lang.String`	`CONTROL_KEY_REFERENCE`
`static java.lang.String`	`CONTROL_KEY_SPECIAL_COLORS` mapping from one double value to color, like: "0.0:white" This might be expanded to support "ge(100.0):red;lt(0):gray;within(0to100);green" and nominal values.
`static java.lang.String`	`CONTROL_KEY_SYMBOL`
`static java.lang.String`	`CONTROL_KEY_SYMBOL_SIZE`
`protected boolean`	`drawLegendLabel`
`protected QDataSet`	`ds` The dataset that is being plotted by the Renderer.
`protected int`	`firstValidIndex` keep track of first and last valid points of the dataset to simplify subclass code and allow them to check if there are any valid points.
`protected java.lang.String`	`id`
`protected java.lang.Exception`	`lastException` When a dataset cannot be loaded, the exception causing the failure will be rendered instead.
`protected int`	`lastValidIndex`
`protected java.lang.String`	`legendLabel`
`protected static java.util.logging.Logger`	`logger`
`protected java.lang.String`	`MARKER_DATASET`
`protected java.lang.String`	`MARKER_X_AXIS_RANGE`
`protected java.lang.String`	`MARKER_Y_AXIS_RANGE`
`protected java.util.Set<java.lang.String>`	`needWorkMarkers`
`static java.lang.String`	`PROP_ACTIVE` display the renderer.
`static java.lang.String`	`PROP_BOTTOMDECORATOR`
`static java.lang.String`	`PROP_COLORBAR`
`static java.lang.String`	`PROP_CONTROL`
`static java.lang.String`	`PROP_DRAWLEGENDLABEL` true if the legend label should be drawn.
`static java.lang.String`	`PROP_ID`
`static java.lang.String`	`PROP_LEGENDLABEL` If non-null and non-zero-length, use this label to describe the renderer in the plot's legend.
`static java.lang.String`	`PROP_RECORDFILE`
`static java.lang.String`	`PROP_TOPDECORATOR`
`protected java.beans.PropertyChangeSupport`	`propertyChangeSupport` Utility field used by bound properties.
`protected java.lang.Exception`	`renderException` This is the exception to be rendered.
`protected Painter`	`topDecorator`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Renderer()

protected Renderer(DataSetDescriptor dsd)

protected Renderer(QDataSet ds)

Constructors
Modifier	Constructor and Description
`protected`	`Renderer()`
`protected`	`Renderer(DataSetDescriptor dsd)`
`protected`	`Renderer(QDataSet ds)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`acceptContext(int x, int y)` Returns true if the render will accept the context for a point.
`boolean`	`acceptsDataSet(QDataSet ds)` return true if the dataset appears to be in a scheme accepted by this renderer.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)` Adds a PropertyChangeListener to the listener list.
`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
`protected void`	`addToStats(int numberOfPoints, long millis, char t)` record the stat to a file.
`static Datum`	`decodeDatum(java.lang.String s, Datum deft)`
`static FillStyle`	`decodeFillStyle(java.lang.String s, FillStyle deflt)` decode the string into a fill style
`static PsymConnector`	`decodePlotSymbolConnectorControl(java.lang.String s, PsymConnector deflt)` decode the string into a plot symbol.
`static PlotSymbol`	`decodePlotSymbolControl(java.lang.String s, PlotSymbol deflt)` decode the string into a plot symbol.
`void`	`drawListIcon(java.awt.Graphics2D g, int x, int y)` implement this to provide nice drawing of icon on printing graphics context.
`static java.lang.String`	`encodeBooleanControl(boolean v)` return the encoding for the boolean value.
`static java.lang.String`	`encodeColorControl(java.awt.Color color)` encode the Color control.
`static java.lang.String`	`encodeDatum(Datum d)`
`static java.lang.String`	`encodeFillStyle(FillStyle fillStyle)` encode the fill style as a string, such as: none, outline, and solid.
`static java.lang.String`	`encodePlotSymbolConnectorControl(PsymConnector psymConnector)` encode the plot symbol connector as a string, such as: solid, dotted
`static java.lang.String`	`encodePlotSymbolControl(PlotSymbol psym)` encode the plot symbol as a string, such as: none, circles, triangles, cross, ex, star, diamond, box
`static java.lang.String`	`formatControl(java.util.Map<java.lang.String,java.lang.String> c)` convenient and official location for method that formats control string.
`protected java.awt.geom.AffineTransform`	`getAffineTransform(DasAxis xAxis, DasAxis yAxis)`
`boolean`	`getBooleanControl(java.lang.String key, boolean deft)` get the boolean control.
`Painter`	`getBottomDecorator()`
`DasColorBar`	`getColorBar()` get the colorbar for the renderer.
`java.awt.Color`	`getColorControl(java.lang.String key, java.awt.Color deft)` get the Color control.
`QDataSet`	`getConsumedDataSet()` return the data for DataSetConsumer, which might be rebinned.
`java.lang.String`	`getControl()` get the string which summarizes the state of the renderer.
`java.lang.String`	`getControl(java.lang.String key, java.lang.String deft)` Get the control.
`DataLoader`	`getDataLoader()`
`QDataSet`	`getDataSet()` returns the current dataset being displayed.
`DataSetDescriptor`	`getDataSetDescriptor()`
`java.lang.String`	`getDataSetID()`
`Datum`	`getDatumControl(java.lang.String key, Datum deft)` get the Datum control.
`double[]`	`getDoubleArrayControl(java.lang.String key, double[] deft)` get the double array control.
`double`	`getDoubleControl(java.lang.String key, double deft)` get the double control.
`java.lang.String`	`getId()`
`int`	`getIntegerControl(java.lang.String key, int deft)` get the integer control.
`protected QDataSet`	`getInternalDataSet()` Renderers should use this internally instead of getDataSet() to support subclasses preprocessing datasets
`java.lang.Exception`	`getLastException()`
`java.lang.String`	`getLegendLabel()` get the label to describe the renderer in the plot's legend.
`javax.swing.Icon`	`getListIcon()` An icon can be provided that will be shown in a list along with the textual description of the element.
`java.lang.String`	`getListLabel()` return a `String` that will help the user identify this item when choosing from a list.
`DasPlot`	`getParent()`
`int`	`getRenderCount()` return the number of times render has been called since the last reset.
`java.lang.String`	`getStatsFile()`
`Painter`	`getTopDecorator()`
`int`	`getUpdateCount()` return the number of times updatePlotImage has been called since the last reset.
`DasAxis.Memento`	`getXmemento()`
`DasAxis.Memento`	`getYmemento()`
`boolean`	`hasControl(java.lang.String key)` return true if the control is specified.
`protected void`	`incrementRenderCount()`
`protected void`	`incrementUpdateCount()`
`protected void`	`installRenderer()`
`protected void`	`invalidateParentCacheImage()`
`boolean`	`isActive()` true when the renderer should be drawn.
`boolean`	`isDrawLegendLabel()` get the switch used to turn off legend label.
`boolean`	`isDumpDataSet()` Getter for property dumpDataSet.
`static boolean`	`isTableDataSet(QDataSet ds)`
`static java.util.Map<java.lang.String,java.lang.String>`	`parseControl(java.lang.String c)` convenient and official location for method that parses control string.
`static double`	`parseLayoutString(java.lang.String sizeStr, int nsize, double emSize, double fail)` return the size encoded as normalized by the container size and em size.
`void`	`postException(java.lang.Exception exception)` notify user of an exception, in the context of the plot.
`void`	`postMessage(java.lang.String message, int messageType, Datum x, Datum y)` post the message, checking to see that there is a parent first.
`void`	`postMessage(java.lang.String message, java.util.logging.Level messageLevel, Datum x, Datum y)` Notify user of an exception, in the context of the plot.
`protected void`	`refresh()` recalculate the plot image and repaint.
`protected void`	`refreshImage()` Deprecated. call refresh which also checks the parent.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener l)` Removes a PropertyChangeListener from the listener list.
`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
`abstract void`	`render(java.awt.Graphics2D g, DasAxis xAxis, DasAxis yAxis)` Render is called whenever the image needs to be refreshed or the content has changed.
`protected void`	`renderException(java.awt.Graphics g, DasAxis xAxis, DasAxis yAxis, java.lang.Exception e)` render the exception on the graphics context.
`void`	`resetCounters()` reset the counters.
`void`	`setActive(boolean active)` set the active property, when false the renderer will not be drawn.
`void`	`setBottomDecorator(Painter bottomDecorator)` add additional painting code to the renderer, which is called before the renderer is called.
`void`	`setColorBar(DasColorBar cb)` set a colorbar for the renderer.
`void`	`setControl(java.lang.String s)` set the control string which contains a number of properties.
`void`	`setDataSet(QDataSet ds)` Set the dataset to be plotted.
`void`	`setDataSetDescriptor(DataSetDescriptor dsd)`
`void`	`setDataSetID(java.lang.String id)`
`void`	`setDataSetLoader(DataLoader loader)`
`void`	`setDrawLegendLabel(boolean drawLegendLabel)` set the switch used to turn off legend label.
`void`	`setDumpDataSet(boolean dumpDataSet)` Setter for property dumpDataSet setting this to true causes the dataSet to be dumped.
`void`	`setException(java.lang.Exception e)` set the exception to be rendered instead of the dataset.
`void`	`setId(java.lang.String id)`
`void`	`setLastException(java.lang.Exception e)` TODO: what is the difference between lastException and exception?
`void`	`setLegendLabel(java.lang.String legendLabel)` set the label to describe the renderer in the plot's legend.
`void`	`setParent(DasPlot parent)`
`void`	`setStatsFile(java.lang.String recordFile)` name of the file where rendering speed is recorded.
`void`	`setTopDecorator(Painter topDecorator)` add additional painting code to the renderer, which is called after the renderer is called.
`static java.awt.Font`	`setUpFont(java.awt.Font f, java.lang.String fontSize)` handle the fontSize property, which has values like "1em" and "7px"
`protected void`	`setUpFont(java.awt.Graphics g1, java.lang.String fontSize)` handle the fontSize property, which has values like "1em" and "7px"
`protected void`	`uninstallRenderer()`
`void`	`update()` Something has changed with the Render, and the plot should come back to allow this render to repaint.
`void`	`updateCacheImage()` The cacheImage is invalidated and updateEvent posted on the event thread by calling update.
`protected void`	`updateImmediately()` updateImmediately is called from DasPlot when it gets an update event from the AWT Event thread.
`void`	`updatePlotImage(DasAxis xAxis, DasAxis yAxis, ProgressMonitor monitor)` updatePlotImage is called once the expensive operation of loading the data is completed.

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

- Field Detail
  - logger
```
protected static final java.util.logging.Logger logger
```
  - ds
```
protected QDataSet ds
```
    The dataset that is being plotted by the Renderer.
  - lastException
```
protected java.lang.Exception lastException
```
    When a dataset cannot be loaded, the exception causing the failure will be rendered instead.
  - renderException
```
protected java.lang.Exception renderException
```
    This is the exception to be rendered. This is so if an exception occurs during drawing, then this will be drawn instead.
  - firstValidIndex
```
protected int firstValidIndex
```
    keep track of first and last valid points of the dataset to simplify subclass code and allow them to check if there are any valid points.
  - lastValidIndex
```
protected int lastValidIndex
```
  - needWorkMarkers
```
protected java.util.Set<java.lang.String> needWorkMarkers
```
  - MARKER_DATASET
```
protected final java.lang.String MARKER_DATASET
```
    See Also:
    
    Constant Field Values
  - MARKER_X_AXIS_RANGE
```
protected final java.lang.String MARKER_X_AXIS_RANGE
```
    See Also:
    
    Constant Field Values
  - MARKER_Y_AXIS_RANGE
```
protected final java.lang.String MARKER_Y_AXIS_RANGE
```
    See Also:
    
    Constant Field Values
  - bottomDecorator
```
protected Painter bottomDecorator
```
  - PROP_BOTTOMDECORATOR
```
public static final java.lang.String PROP_BOTTOMDECORATOR
```
    See Also:
    
    Constant Field Values
  - topDecorator
```
protected Painter topDecorator
```
  - PROP_TOPDECORATOR
```
public static final java.lang.String PROP_TOPDECORATOR
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_COLOR
```
public static final java.lang.String CONTROL_KEY_COLOR
```
    allocate a bunch of canonical properties. See http://autoplot.org/developer.guessRenderType#Proposed_extensions
    
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_FILL_COLOR
```
public static final java.lang.String CONTROL_KEY_FILL_COLOR
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_FILL_DIRECTION
```
public static final java.lang.String CONTROL_KEY_FILL_DIRECTION
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_COLOR_TABLE
```
public static final java.lang.String CONTROL_KEY_COLOR_TABLE
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_LINE_THICK
```
public static final java.lang.String CONTROL_KEY_LINE_THICK
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_LINE_STYLE
```
public static final java.lang.String CONTROL_KEY_LINE_STYLE
```
    used in ContoursRenderer and EventsRenderer, values like DotDashes and Solid
    
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_SYMBOL
```
public static final java.lang.String CONTROL_KEY_SYMBOL
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_SYMBOL_SIZE
```
public static final java.lang.String CONTROL_KEY_SYMBOL_SIZE
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_SPECIAL_COLORS
```
public static final java.lang.String CONTROL_KEY_SPECIAL_COLORS
```
    mapping from one double value to color, like:
    - "0.0:white"
    This might be expanded to support "ge(100.0):red;lt(0):gray;within(0to100);green" and nominal values.
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_FILL_TEXTURE
```
public static final java.lang.String CONTROL_KEY_FILL_TEXTURE
```
    when filling a region, use this texture (solid,hash,backhash,crosshash) to fill.
    
    See Also:
    
    GraphUtil.fillWithTexture(java.awt.Graphics2D, java.awt.geom.GeneralPath, java.awt.Color, java.lang.String), Constant Field Values
  - CONTROL_KEY_FONT_SIZE
```
public static final java.lang.String CONTROL_KEY_FONT_SIZE
```
    font size relative to the parent, so "" or "1em" is the same size.
    
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_REFERENCE
```
public static final java.lang.String CONTROL_KEY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_DRAW_ERROR
```
public static final java.lang.String CONTROL_KEY_DRAW_ERROR
```
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_MODULO_Y
```
public static final java.lang.String CONTROL_KEY_MODULO_Y
```
    modulo Y indicates that a difference in 23 hours is the same as -1 hours.
    
    See Also:
    
    Constant Field Values
  - CONTROL_KEY_MODULO_X
```
public static final java.lang.String CONTROL_KEY_MODULO_X
```
    See Also:
    
    Constant Field Values
  - PROP_CONTROL
```
public static final java.lang.String PROP_CONTROL
```
    See Also:
    
    Constant Field Values
  - control
```
protected java.lang.String control
```
    generic control string, that is handled by the renderer. In general, this should be a ampersand-delimited string of name=value pairs. This may return values that are represented as a separate control, such as color. fill=red,above,5.0;grey,below,0.0&ref=2.5 (Note these are example controls which are not implemented.)
  - PROP_ACTIVE
```
public static final java.lang.String PROP_ACTIVE
```
    display the renderer. This is allows a renderer to be disabled without removing it from the application.
    
    See Also:
    
    Constant Field Values
  - PROP_LEGENDLABEL
```
public static final java.lang.String PROP_LEGENDLABEL
```
    If non-null and non-zero-length, use this label to describe the renderer in the plot's legend.
    
    See Also:
    
    Constant Field Values
  - legendLabel
```
protected java.lang.String legendLabel
```
  - drawLegendLabel
```
protected boolean drawLegendLabel
```
  - PROP_DRAWLEGENDLABEL
```
public static final java.lang.String PROP_DRAWLEGENDLABEL
```
    true if the legend label should be drawn.
    
    See Also:
    
    Constant Field Values
  - id
```
protected java.lang.String id
```
  - PROP_ID
```
public static final java.lang.String PROP_ID
```
    See Also:
    
    Constant Field Values
  - PROP_COLORBAR
```
public static final java.lang.String PROP_COLORBAR
```
    See Also:
    
    Constant Field Values
  - colorBar
```
protected DasColorBar colorBar
```
  - PROP_RECORDFILE
```
public static final java.lang.String PROP_RECORDFILE
```
    See Also:
    
    Constant Field Values
  - propertyChangeSupport
```
protected java.beans.PropertyChangeSupport propertyChangeSupport
```
    Utility field used by bound properties.
- Constructor Detail
  - Renderer
```
protected Renderer(DataSetDescriptor dsd)
```
  - Renderer
```
protected Renderer(QDataSet ds)
```
  - Renderer
```
protected Renderer()
```
- Method Detail
  - getParent
```
public DasPlot getParent()
```
  - setParent
```
public void setParent(DasPlot parent)
```
  - getXmemento
```
public DasAxis.Memento getXmemento()
```
  - getYmemento
```
public DasAxis.Memento getYmemento()
```
  - postMessage
```
public void postMessage(java.lang.String message,
                        int messageType,
                        Datum x,
                        Datum y)
```
    post the message, checking to see that there is a parent first.
    
    Parameters:
    
    message - the message
    
    messageType - the message type, DasPlot.INFO, DasPlot.WARNING, or DasPlot.SEVERE.
    
    x - the X position or null
    
    y - the Y position or null
  - postMessage
```
public void postMessage(java.lang.String message,
                        java.util.logging.Level messageLevel,
                        Datum x,
                        Datum y)
```
    Notify user of an exception, in the context of the plot. A position in the data space may be specified to locate the text within the data context. Note either or both x or y may be null. Messages must only be posted while the Renderer's render method is called, not during updatePlotImage. All messages are cleared before the render step. (TODO:check on this)
    
    Parameters:
    
    message - the text to be displayed, may contain granny text.
    
    messageLevel - allows java.util.logging.Level to be used, for example Level.INFO, Level.WARNING, and Level.SEVERE
    
    x - if non-null, the location on the x axis giving context for the text.
    
    y - if non-null, the location on the y axis giving context for the text.
  - postException
```
public void postException(java.lang.Exception exception)
```
    notify user of an exception, in the context of the plot. This is similar to postMessage(renderer, exception.getMessage(), DasPlot.SEVERE, null, null ) except that it does catch CancelledOperationExceptions and reduced the severity since the user probably initiated the condition.
    
    Parameters:
    
    exception - the exception to post.
  - isTableDataSet
```
public static boolean isTableDataSet(QDataSet ds)
```
  - invalidateParentCacheImage
```
protected void invalidateParentCacheImage()
```
  - getDataSet
```
public QDataSet getDataSet()
```
    returns the current dataset being displayed.
    
    Returns:
  - getInternalDataSet
```
protected QDataSet getInternalDataSet()
```
    Renderers should use this internally instead of getDataSet() to support subclasses preprocessing datasets
    
    Returns:
  - getConsumedDataSet
```
public QDataSet getConsumedDataSet()
```
    return the data for DataSetConsumer, which might be rebinned.
    
    Specified by:
    
    getConsumedDataSet in interface DataSetConsumer
    
    Returns:
  - isDumpDataSet
```
public boolean isDumpDataSet()
```
    Getter for property dumpDataSet.
    
    Returns:
    
    Value of property dumpDataSet.
  - setDumpDataSet
```
public void setDumpDataSet(boolean dumpDataSet)
```
    Setter for property dumpDataSet setting this to true causes the dataSet to be dumped.
    
    Parameters:
    
    dumpDataSet - New value of property dumpDataSet.
  - getBottomDecorator
```
public Painter getBottomDecorator()
```
  - setBottomDecorator
```
public void setBottomDecorator(Painter bottomDecorator)
```
    add additional painting code to the renderer, which is called before the renderer is called.
    
    Parameters:
    
    bottomDecorator - the Painter to call, or null to clear.
  - getTopDecorator
```
public Painter getTopDecorator()
```
  - setTopDecorator
```
public void setTopDecorator(Painter topDecorator)
```
    add additional painting code to the renderer, which is called after the renderer is called.
    
    Parameters:
    
    topDecorator - the Painter to call, or null to clear.
  - setLastException
```
public void setLastException(java.lang.Exception e)
```
    TODO: what is the difference between lastException and exception?
    
    Parameters:
    
    e -
  - getLastException
```
public java.lang.Exception getLastException()
```
  - acceptsDataSet
```
public boolean acceptsDataSet(QDataSet ds)
```
    return true if the dataset appears to be in a scheme accepted by this renderer. This should assume that axis units can be reset, etc.
    
    Parameters:
    
    ds -
    
    Returns:
    
    true if the dataset appears to be acceptable.
  - setDataSet
```
public void setDataSet(QDataSet ds)
```
    Set the dataset to be plotted. Different renderers accept QDataSets with different schemes. For example SeriesRenderer takes: ds[t] rank 1 dataset with rank 1 DEPEND_0 or ds[t,n] rank 2 bundle dataset with X in ds[t,0] and Y in ds[t,n-1] and SpectrogramRenderer takes: ds[t,y] rank 2 table dataset ds[n,t,y] rank 3 dataset with the first dimension join See each renderer's documentation for the schemes it takes. Note the lastException property is cleared, even when the dataset is null.
    
    Parameters:
    
    ds -
  - setException
```
public void setException(java.lang.Exception e)
```
    set the exception to be rendered instead of the dataset.
    
    Parameters:
    
    e -
  - setDataSetID
```
public void setDataSetID(java.lang.String id)
                  throws DasException
```
    Throws:
    
    DasException
  - getDataSetID
```
public java.lang.String getDataSetID()
```
  - setControl
```
public void setControl(java.lang.String s)
```
    set the control string which contains a number of properties. These are defined for each renderer, but they should try to be consistent. See http://autoplot.org/developer.guessRenderType#Proposed_extensions When overriding this, be sure to call super.
    
    Parameters:
    
    s - the control
    
    See Also:
    
    etc
  - getControl
```
public java.lang.String getControl()
```
    get the string which summarizes the state of the renderer. These allow a compact string to contain the renderer settings. This should be an ampersand-delimited list of name=value pairs.
    
    Returns:
  - formatControl
```
public static java.lang.String formatControl(java.util.Map<java.lang.String,java.lang.String> c)
```
    convenient and official location for method that formats control string.
    
    Parameters:
    
    c -
    
    Returns:
  - parseControl
```
public static java.util.Map<java.lang.String,java.lang.String> parseControl(java.lang.String c)
```
    convenient and official location for method that parses control string. This will split on ampersand, and when no ampersands are found then it will try semicolons. This is to support embedding the control string in other control strings (like Autoplot URIs) which use ampersands.
    
    Parameters:
    
    c - the control string or null.
    
    Returns:
    
    the control string, parsed.
  - getControl
```
public java.lang.String getControl(java.lang.String key,
                                   java.lang.String deft)
```
    Get the control. This provides an easy way for renderers to have controls in a compact string.
    
    Parameters:
    
    key - the key name.
    
    deft - the default value (or null)
    
    Returns:
    
    the string value of the control.
    
    See Also:
    
    getDoubleControl(java.lang.String, double), getBooleanControl(java.lang.String, boolean)
  - hasControl
```
public boolean hasControl(java.lang.String key)
```
    return true if the control is specified.
    
    Parameters:
    
    key - the key name
    
    Returns:
    
    true if the control is specified.
  - getBooleanControl
```
public boolean getBooleanControl(java.lang.String key,
                                 boolean deft)
```
    get the boolean control.
    
    Parameters:
    
    key - the key name.
    
    deft - the default value.
    
    Returns:
    
    the boolean value, where "T" is true, false otherwise; or the default when the value is not found.
  - encodeBooleanControl
```
public static java.lang.String encodeBooleanControl(boolean v)
```
    return the encoding for the boolean value.
    
    Parameters:
    
    v - the boolean value.
    
    Returns:
    
    "T" or "F"
  - getDoubleControl
```
public double getDoubleControl(java.lang.String key,
                               double deft)
```
    get the double control.
    
    Parameters:
    
    key - the key name.
    
    deft - the default value.
    
    Returns:
    
    the double, parsed with Double.parseDouble; or the default when the value is not found.
  - getIntegerControl
```
public int getIntegerControl(java.lang.String key,
                             int deft)
```
    get the integer control.
    
    Parameters:
    
    key - the key name.
    
    deft - the default value.
    
    Returns:
    
    the int, parsed with Integer.parseInt; or the default when the value is not found.
  - getDoubleArrayControl
```
public double[] getDoubleArrayControl(java.lang.String key,
                                      double[] deft)
```
    get the double array control. These should be encoded on a string with commas delimiting values.
    
    Parameters:
    
    key - the key name.
    
    deft - the default value.
    
    Returns:
    
    the double array, each element parsed with Double.parseDouble or the default when the value is not found.
  - getDatumControl
```
public Datum getDatumControl(java.lang.String key,
                             Datum deft)
```
    get the Datum control.
    
    Parameters:
    
    key - the key name.
    
    deft - the default value, which also provides the units.
    
    Returns:
    
    the Datum or the default when the value is not found.
  - getColorControl
```
public java.awt.Color getColorControl(java.lang.String key,
                                      java.awt.Color deft)
```
    get the Color control.
    
    Parameters:
    
    key - the key name.
    
    deft - the default value
    
    Returns:
    
    the Color or the default when the value is not found.
    
    See Also:
    
    ColorUtil.decodeColor(java.lang.String)
  - encodeColorControl
```
public static java.lang.String encodeColorControl(java.awt.Color color)
```
    encode the Color control.
    
    Parameters:
    
    color -
    
    Returns:
    
    the color encoded as a string.
    
    See Also:
    
    ColorUtil.encodeColor(java.awt.Color)
  - encodePlotSymbolControl
```
public static java.lang.String encodePlotSymbolControl(PlotSymbol psym)
```
    encode the plot symbol as a string, such as: none, circles, triangles, cross, ex, star, diamond, box
    
    Parameters:
    
    psym - the plot symbol.
    
    Returns:
    
    the string encoding.
  - decodePlotSymbolControl
```
public static PlotSymbol decodePlotSymbolControl(java.lang.String s,
                                                 PlotSymbol deflt)
```
    decode the string into a plot symbol.
    
    Parameters:
    
    s - the symbol name, such as none, circles, triangles, cross, ex, star, diamond, box
    
    deflt - the symbol to use when the value is not parsed.
    
    Returns:
    
    the parsed value.
  - encodePlotSymbolConnectorControl
```
public static java.lang.String encodePlotSymbolConnectorControl(PsymConnector psymConnector)
```
    encode the plot symbol connector as a string, such as: solid, dotted
    
    Parameters:
    
    psymConnector -
    
    Returns:
    
    the string encoding.
  - decodePlotSymbolConnectorControl
```
public static PsymConnector decodePlotSymbolConnectorControl(java.lang.String s,
                                                             PsymConnector deflt)
```
    decode the string into a plot symbol.
    
    Parameters:
    
    s - the symbol name, such as none, dashes, dashFine
    
    deflt - the symbol to use when the value is not parsed.
    
    Returns:
    
    the parsed value.
  - decodeFillStyle
```
public static FillStyle decodeFillStyle(java.lang.String s,
                                        FillStyle deflt)
```
    decode the string into a fill style
    
    Parameters:
    
    s - the symbol name, such as none, solid, and outline.
    
    deflt - the value to use when the value is not parsed.
    
    Returns:
    
    the parsed value.
  - encodeFillStyle
```
public static java.lang.String encodeFillStyle(FillStyle fillStyle)
```
    encode the fill style as a string, such as: none, outline, and solid.
    
    Parameters:
    
    fillStyle -
    
    Returns:
    
    the string encoding.
  - encodeDatum
```
public static java.lang.String encodeDatum(Datum d)
```
  - decodeDatum
```
public static Datum decodeDatum(java.lang.String s,
                                Datum deft)
```
  - getAffineTransform
```
protected java.awt.geom.AffineTransform getAffineTransform(DasAxis xAxis,
                                                           DasAxis yAxis)
```
  - render
```
public abstract void render(java.awt.Graphics2D g,
                            DasAxis xAxis,
                            DasAxis yAxis)
```
    Render is called whenever the image needs to be refreshed or the content has changed. This operation should occur with an animation-interactive time scale, and an image should be cached when this is not possible. The graphics object will have its origin at the upper-left corner of the screen.
    
    Parameters:
    
    g - the graphics context in the canvas reference frame.
    
    xAxis - the axis relating x data coordinates to horizontal pixel coordinates
    
    yAxis - the axis relating y data coordinates to horizontal pixel coordinates
  - acceptContext
```
public boolean acceptContext(int x,
                             int y)
```
    Returns true if the render will accept the context for a point. That is, the renderer affected that point, or nearby points. This is used currently to provide a way for the operator to click on a plot and directly edit the renderer which drew the pixel.
    
    Parameters:
    
    x - the x coordinate in the canvas coordinate system.
    
    y - the y coordinate in the canvas coordinate system.
    
    Returns:
    
    true if the renderer will accept the context.
  - renderException
```
protected void renderException(java.awt.Graphics g,
                               DasAxis xAxis,
                               DasAxis yAxis,
                               java.lang.Exception e)
```
    render the exception on the graphics context. Presently this just hands off the exception to the parent plot's postMessage method so it will appear in a message bubble.
    
    Parameters:
    
    g - the graphics context in the canvas reference frame
    
    xAxis - the axis relating x data coordinates to horizontal pixel coordinates
    
    yAxis - the axis relating y data coordinates to horizontal pixel coordinates
    
    e - the exception.
  - updatePlotImage
```
public void updatePlotImage(DasAxis xAxis,
                            DasAxis yAxis,
                            ProgressMonitor monitor)
                     throws DasException
```
    updatePlotImage is called once the expensive operation of loading the data is completed. This operation should occur on an interactive time scale. This is an opportunity to create a cache image of the data with the current axis state, when the render operation cannot operate on an animation interactive time scale. Also, several Renders can be updating at once on separate threads, while the render methods must be called sequentially. Only Renderer should call this method! (This should be protected then, but this is not possible because of exiting use. TODO: introduce "revalidate" to replace this operation.)
    
    Parameters:
    
    xAxis - the axis relating x data coordinates to horizontal pixel coordinates
    
    yAxis - the axis relating y data coordinates to horizontal pixel coordinates
    
    monitor - a monitor for the operation. Note the updatePlotImage operation should be fast (<1000ms).
    
    Throws:
    
    DasException
  - refreshImage
```
protected void refreshImage()
```
    Deprecated. call refresh which also checks the parent.
    
    refresh, but only if the parent has been set.
  - update
```
public void update()
```
    Something has changed with the Render, and the plot should come back to allow this render to repaint. Its cacheImage is invalidated and a repaint is posted on the event thread.
  - updateCacheImage
```
public void updateCacheImage()
```
    The cacheImage is invalidated and updateEvent posted on the event thread by calling update.
  - updateImmediately
```
protected void updateImmediately()
```
    updateImmediately is called from DasPlot when it gets an update event from the AWT Event thread. This should trigger a data load and eventually a refresh to render the dataset.
  - refresh
```
protected void refresh()
```
    recalculate the plot image and repaint. The dataset or exception have been updated, or the axes have changed, so we need to perform updatePlotImage to do the expensive parts of rendering. This is only called from the resize method of DasPlot.
  - setDataSetDescriptor
```
public void setDataSetDescriptor(DataSetDescriptor dsd)
```
  - getDataLoader
```
public DataLoader getDataLoader()
```
  - setDataSetLoader
```
public void setDataSetLoader(DataLoader loader)
```
  - getDataSetDescriptor
```
public DataSetDescriptor getDataSetDescriptor()
```
  - installRenderer
```
protected void installRenderer()
```
  - uninstallRenderer
```
protected void uninstallRenderer()
```
  - isActive
```
public boolean isActive()
```
    true when the renderer should be drawn.
    
    Returns:
    
    true when the renderer should be drawn.
  - setActive
```
public void setActive(boolean active)
```
    set the active property, when false the renderer will not be drawn. This is allows a renderer to be disabled without removing it from the application.
    
    Parameters:
    
    active - false if the renderer should not be drawn.
  - getLegendLabel
```
public java.lang.String getLegendLabel()
```
    get the label to describe the renderer in the plot's legend. If zero-length, then the legend label should be hidden.
    
    Returns:
    
    the label to describe the renderer
  - setLegendLabel
```
public void setLegendLabel(java.lang.String legendLabel)
```
    set the label to describe the renderer in the plot's legend. If zero-length, then the legend label should be hidden.
    
    Parameters:
    
    legendLabel - the label to describe the renderer
  - isDrawLegendLabel
```
public boolean isDrawLegendLabel()
```
    get the switch used to turn off legend label. This allows the label to be hidden without loosing the information it provides.
    
    Returns:
    
    true if the legend label should be drawn
  - setDrawLegendLabel
```
public void setDrawLegendLabel(boolean drawLegendLabel)
```
    set the switch used to turn off legend label. This allows the label to be hidden without loosing the information it provides.
    
    Parameters:
    
    drawLegendLabel - true if the legend label should be drawn
  - getId
```
public java.lang.String getId()
```
  - setId
```
public void setId(java.lang.String id)
```
  - drawListIcon
```
public void drawListIcon(java.awt.Graphics2D g,
                         int x,
                         int y)
```
    Description copied from interface: Displayable
    
    implement this to provide nice drawing of icon on printing graphics context.
    
    Specified by:
    
    drawListIcon in interface Displayable
    
    Parameters:
    
    g - the graphics context.
    
    x - the x position, typically 0.
    
    y - the y position, typically 0.
  - getListIcon
```
public javax.swing.Icon getListIcon()
```
    Description copied from interface: Displayable
    
    An icon can be provided that will be shown in a list along with the textual description of the element. This method should return null if there is no icon available, or a roughly 16x16 pixel icon.
    
    Specified by:
    
    getListIcon in interface Displayable
    
    Returns:
    
    the icon.
  - getListLabel
```
public java.lang.String getListLabel()
```
    Description copied from interface: Displayable
    
    return a String that will help the user identify this item when choosing from a list.
    
    Specified by:
    
    getListLabel in interface Displayable
    
    Returns:
    
    the list label.
  - setColorBar
```
public void setColorBar(DasColorBar cb)
```
    set a colorbar for the renderer. By default, the renderer simply ignores the colorbar, but instances may introduce special handling. WARNING: some subclasses override this, but do not call super.setColorBar.
    
    Parameters:
    
    cb - a colorbar
  - getColorBar
```
public DasColorBar getColorBar()
```
    get the colorbar for the renderer.
    
    Returns:
    
    the colorbar for the renderer.
  - setUpFont
```
public static java.awt.Font setUpFont(java.awt.Font f,
                                      java.lang.String fontSize)
```
    handle the fontSize property, which has values like "1em" and "7px"
    
    Parameters:
    
    f - the parent font.
    
    fontSize - fontSize property, for example "1em" and "7px"
    
    Returns:
    
    the relative font.
  - parseLayoutString
```
public static double parseLayoutString(java.lang.String sizeStr,
                                       int nsize,
                                       double emSize,
                                       double fail)
                                throws java.text.ParseException
```
    return the size encoded as normalized by the container size and em size.
    
    Parameters:
    
    sizeStr - spec like "5em" or "50%"
    
    nsize - the dimension for percents, for example the size of the canvas or column.
    
    emSize - the size of the current font, for ems.
    
    fail - value to return if the spec cannot be parsed.
    
    Returns:
    
    the size in pixels
    
    Throws:
    
    java.text.ParseException
    
    See Also:
    
    DasDevicePosition.parseLayoutStr(java.lang.String, double, int, double)
  - setUpFont
```
protected void setUpFont(java.awt.Graphics g1,
                         java.lang.String fontSize)
```
    handle the fontSize property, which has values like "1em" and "7px"
    
    Parameters:
    
    g1 -
    
    fontSize - fontSize property, for example "1em" and "7px"
  - incrementRenderCount
```
protected void incrementRenderCount()
```
  - getRenderCount
```
public int getRenderCount()
```
    return the number of times render has been called since the last reset.
    
    Returns:
    
    number of times render has been called since the last reset.
  - incrementUpdateCount
```
protected void incrementUpdateCount()
```
  - getUpdateCount
```
public int getUpdateCount()
```
    return the number of times updatePlotImage has been called since the last reset.
    
    Returns:
    
    the number of times updatePlotImage has been called since the last reset.
  - resetCounters
```
public void resetCounters()
```
    reset the counters.
  - getStatsFile
```
public java.lang.String getStatsFile()
```
  - setStatsFile
```
public void setStatsFile(java.lang.String recordFile)
```
    name of the file where rendering speed is recorded.
    
    Parameters:
    
    recordFile -
  - addToStats
```
protected void addToStats(int numberOfPoints,
                          long millis,
                          char t)
```
    record the stat to a file.
    
    Parameters:
    
    numberOfPoints -
    
    millis - milliseconds
    
    t - 'r' for rendering, 'u' for updatePlotImage
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Adds a PropertyChangeListener to the listener list.
    
    Parameters:
    
    l - The listener to add.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
```
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
```
    Removes a PropertyChangeListener from the listener list.
    
    Parameters:
    
    l - The listener to remove.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
```

Class Renderer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

ds

lastException

renderException

firstValidIndex

lastValidIndex

needWorkMarkers

MARKER_DATASET

MARKER_X_AXIS_RANGE

MARKER_Y_AXIS_RANGE

bottomDecorator

PROP_BOTTOMDECORATOR

topDecorator

PROP_TOPDECORATOR

CONTROL_KEY_COLOR

CONTROL_KEY_FILL_COLOR

CONTROL_KEY_FILL_DIRECTION

CONTROL_KEY_COLOR_TABLE

CONTROL_KEY_LINE_THICK

CONTROL_KEY_LINE_STYLE

CONTROL_KEY_SYMBOL

CONTROL_KEY_SYMBOL_SIZE

CONTROL_KEY_SPECIAL_COLORS

CONTROL_KEY_FILL_TEXTURE

CONTROL_KEY_FONT_SIZE

CONTROL_KEY_REFERENCE

CONTROL_KEY_DRAW_ERROR

CONTROL_KEY_MODULO_Y

CONTROL_KEY_MODULO_X

PROP_CONTROL

control

PROP_ACTIVE

PROP_LEGENDLABEL

legendLabel

drawLegendLabel

PROP_DRAWLEGENDLABEL

id

PROP_ID

PROP_COLORBAR

colorBar

PROP_RECORDFILE

propertyChangeSupport

Constructor Detail

Renderer

Renderer

Renderer

Method Detail

getParent

setParent

getXmemento

getYmemento

postMessage

postMessage

postException

isTableDataSet

invalidateParentCacheImage

getDataSet

getInternalDataSet

getConsumedDataSet

isDumpDataSet

setDumpDataSet

getBottomDecorator

setBottomDecorator

getTopDecorator

setTopDecorator

setLastException

getLastException

acceptsDataSet

setDataSet

setException

setDataSetID

getDataSetID

setControl

getControl