org.autoplot.dom

Class PlotElementController

java.lang.Object

org.autoplot.dom.DomNodeController

org.autoplot.dom.PlotElementController

public class PlotElementController
extends DomNodeController

PlotElementController manages the PlotElement, for example resolving the datasource and loading the dataset. Once the data is loaded, the listening PlotElementController receives the update and does the following:

1. resolve the plot type: spectrogram, lineplot, stack of lineplot, etc, using AutoplotUtil.guessRenderType(fillDs);
2. reset the plot element, setting the plot type and creating children if needed. For example, a B-GSM (demo 5) is resolved by creating three children, and handing the components off to them.
3. if the component property is not empty, then we implement the component and display that.
4. adjusting the component slice index will not affect ranging when the index is changed.

Field Summary

Fields

Modifier and Type	Field and Description
protected QDataSet	dataSet
static int	LARGE_DATASET_COUNT
static java.lang.String	PROP_DATASET the current dataset plotted, after operations (component property) has been applied.
static java.lang.String	PROP_DSFRESET when true, a change in the DataSourceFilter should reset the plotElement.
static java.lang.String	PROP_RESETCOMPONENT true indicates that the component should be reset when the dataset arrives.
static java.lang.String	PROP_RESETPLOTELEMENT true indicates the controller should install a new renderer to implement the renderType selection.
static java.lang.String	PROP_RESETRANGES true indicates the controller should autorange next time the fillDataSet is changed.
static java.lang.String	PROP_RESETRENDERTYPE true indicates the peer should be reset to the current renderType.
static java.lang.String	PROP_SLICEAUTORANGES
protected Renderer	renderer
static int	SYMSIZE_DATAPOINT_COUNT switch over between fine and course points.

Fields inherited from class org.autoplot.dom.DomNodeController

changesSupport, propertyChangeSupport

Constructor Summary

Constructors

Constructor and Description
PlotElementController(ApplicationModel model, Application dom, PlotElement plotElement)

Method Summary

Modifier and Type	Method and Description
static boolean	axisDimensionsChange(RenderType oldRenderType, RenderType newRenderType) true indicates that the new renderType makes the axis dimensions change.
void	bindToContoursRenderer(Renderer renderer)
void	bindToDigitalRenderer(DigitalRenderer renderer)
void	bindToEventsRenderer(EventsRenderer renderer)
void	bindToImageVectorDataSetRenderer(HugeScatterRenderer renderer)
void	bindToPolarPlotRenderer(PolarPlotRenderer renderer)
void	bindToSeriesRenderer(SeriesRenderer seriesRenderer)
void	bindToSpectrogramRenderer(SpectrogramRenderer spectrogramRenderer)
void	bindToTickCurveRenderer(TickCurveRenderer renderer)
protected void	disconnect() remove all property change listeners.
static void	doAutoranging(PlotElement peleCopy, java.util.Map<java.lang.String,java.lang.Object> props, QDataSet fillDs) This is the old updateFillSeries and updateFillSpectrogram code.
static void	doAutoranging(PlotElement peleCopy, java.util.Map<java.lang.String,java.lang.Object> props, QDataSet fillDs, boolean ignoreDsProps) This is the old updateFillSeries and updateFillSpectrogram code.
void	doResetRenderType(RenderType renderType) used to explicitly set the rendering type.
Application	getApplication() return the application that the plotElement belongs to.
java.util.List<PlotElement>	getChildPlotElements() return child plotElements, which are plotElements that share a datasource but pull out a component of the data.
DasPlot	getDasPlot() return the plot containing this plotElement's renderer, or null.
QDataSet	getDataSet() the current dataset plotted, after operations (component property) has been applied.
DataSourceFilter	getDataSourceFilter() return the data source and filter for this plotElement.
PlotElement	getParentPlotElement() return the parent plotElement, or null if the plotElement doesn't have a parent.
PlotElement	getPlotElement() return the plot element.
Renderer	getRenderer()
boolean	isDsfReset()
boolean	isPendingChanges() Some sort of processing is going on, so wait until idle.
boolean	isResetComponent()
boolean	isResetPlotElement()
boolean	isResetRanges()
boolean	isResetRenderType()
boolean	isSliceAutoranges()
protected void	maybeCreateDasPeer() create the peer that will actually do the painting.
void	pendingChanges(java.util.Map<java.lang.Object,java.lang.Object> changes) return a list of all the pending changes.
protected void	removeReferences() remove any direct references this controller has as it is being deleted.
static java.lang.String	resolveRenderType(QDataSet fillds) Resolve the renderType and renderControl for the dataset.
protected void	setChildPlotElements(java.util.List<PlotElement> plotElements) set the child plotElements.
void	setDsfReset(boolean dsfReset)
protected void	setParentPlotElement(PlotElement p) set the parent plotElement.
void	setRenderer(Renderer renderer) set the renderer controlled by this PlotElement controller.
void	setResetComponent(boolean resetComponent)
void	setResetPlotElement(boolean resetPlotElement)
void	setResetRanges(boolean resetRanges)
void	setResetRenderType(boolean resetRenderType)
void	setSliceAutoranges(boolean sliceAutoranges)
java.lang.String	toString()

Methods inherited from class org.autoplot.dom.DomNodeController

addPropertyChangeListener, addPropertyChangeListener, changePerformed, containsString, getController, insertString, isValueAdjusting, mutatorLock, performingChange, printStats, registerPendingChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

SYMSIZE_DATAPOINT_COUNT

public static final int SYMSIZE_DATAPOINT_COUNT

switch over between fine and course points.

See Also:

Constant Field Values

LARGE_DATASET_COUNT

public static final int LARGE_DATASET_COUNT

See Also:

Constant Field Values

PROP_DATASET

public static final java.lang.String PROP_DATASET

the current dataset plotted, after operations (component property) has been applied.

See Also:

Constant Field Values

dataSet

protected QDataSet dataSet

PROP_RESETRANGES

public static final java.lang.String PROP_RESETRANGES

true indicates the controller should autorange next time the fillDataSet is changed.

See Also:

Constant Field Values

PROP_RESETPLOTELEMENT

public static final java.lang.String PROP_RESETPLOTELEMENT

true indicates the controller should install a new renderer to implement the renderType selection. This may mean that we introduce or remove child plotElements. This implies resetRenderType.

See Also:

Constant Field Values

PROP_RESETCOMPONENT

public static final java.lang.String PROP_RESETCOMPONENT

true indicates that the component should be reset when the dataset arrives. This is added as a controller property so that clients can clear this setting if they do not want the component to be reset. This is only considered if resetPlotElement is set.

See Also:

Constant Field Values

PROP_RESETRENDERTYPE

public static final java.lang.String PROP_RESETRENDERTYPE

true indicates the peer should be reset to the current renderType.

See Also:

Constant Field Values

PROP_DSFRESET

public static final java.lang.String PROP_DSFRESET

when true, a change in the DataSourceFilter should reset the plotElement.

See Also:

Constant Field Values

PROP_SLICEAUTORANGES

public static final java.lang.String PROP_SLICEAUTORANGES

See Also:

Constant Field Values

renderer

protected Renderer renderer

Constructor Detail

PlotElementController

public PlotElementController(ApplicationModel model,
                             Application dom,
                             PlotElement plotElement)

Method Detail

disconnect

protected void disconnect()

remove all property change listeners.

removeReferences

protected void removeReferences()

remove any direct references this controller has as it is being deleted.

getChildPlotElements

public java.util.List<PlotElement> getChildPlotElements()

return child plotElements, which are plotElements that share a datasource but pull out a component of the data.

Returns:

setChildPlotElements

protected void setChildPlotElements(java.util.List<PlotElement> plotElements)

set the child plotElements.

Parameters:

plotElements -

setParentPlotElement

protected void setParentPlotElement(PlotElement p)

set the parent plotElement. this is used when copying.

Parameters:

p -

getParentPlotElement

public PlotElement getParentPlotElement()

return the parent plotElement, or null if the plotElement doesn't have a parent.

Returns:

getPlotElement

public PlotElement getPlotElement()

return the plot element.

Returns:

the plot element.

getDataSet

public QDataSet getDataSet()

the current dataset plotted, after operations (component property) has been applied.

Returns:

resolveRenderType

public static java.lang.String resolveRenderType(QDataSet fillds)

Resolve the renderType and renderControl for the dataset. This may be set explicitly by the dataset, in its RENDER_TYPE property, or resolved using the dataset scheme.

Parameters:

fillds -

Returns:

the render string with canonical types. The result will always contain a greater than (>).

axisDimensionsChange

public static boolean axisDimensionsChange(RenderType oldRenderType,
                                           RenderType newRenderType)

true indicates that the new renderType makes the axis dimensions change. For example, switching from spectrogram to series (to get a stack of components) causes the z axis to become the yaxis.

Parameters:

oldRenderType -

newRenderType -

Returns:

true if the dimensions change.

isResetRanges

public boolean isResetRanges()

setResetRanges

public void setResetRanges(boolean resetRanges)

isResetPlotElement

public boolean isResetPlotElement()

setResetPlotElement

public void setResetPlotElement(boolean resetPlotElement)

isResetComponent

public boolean isResetComponent()

setResetComponent

public void setResetComponent(boolean resetComponent)

isResetRenderType

public boolean isResetRenderType()

setResetRenderType

public void setResetRenderType(boolean resetRenderType)

isDsfReset

public boolean isDsfReset()

setDsfReset

public void setDsfReset(boolean dsfReset)

isSliceAutoranges

public boolean isSliceAutoranges()

setSliceAutoranges

public void setSliceAutoranges(boolean sliceAutoranges)

getRenderer

public Renderer getRenderer()

setRenderer

public void setRenderer(Renderer renderer)

set the renderer controlled by this PlotElement controller. This should be used with caution.

Parameters:

renderer -

See Also:

PlotCommand

doAutoranging

public static void doAutoranging(PlotElement peleCopy,
                                 java.util.Map<java.lang.String,java.lang.Object> props,
                                 QDataSet fillDs)

This is the old updateFillSeries and updateFillSpectrogram code. This calculates ranges and preferred symbol settings, and puts the values in peleCopy.plotDefaults. The dom Plot containing this plotElement should be listening for changes in plotElement.plotDefaults, and can then decide if it wants to use the autorange settings. This also sets the style node of the plotElement copy, so its values should be sync'ed as well. This routine can be found by searching for "liver," since it is not the heart but pretty close to it.

Parameters:

peleCopy - the plot element.

props - metadata provided by the data source, converted to uniform QDataSet scheme (e.g. get(DEPEND_0).get(TYPICAL_MIN) )

fillDs - the dataset

doAutoranging

public static void doAutoranging(PlotElement peleCopy,
                                 java.util.Map<java.lang.String,java.lang.Object> props,
                                 QDataSet fillDs,
                                 boolean ignoreDsProps)

This is the old updateFillSeries and updateFillSpectrogram code. This calculates ranges and preferred symbol settings, and puts the values in peleCopy.plotDefaults. The dom Plot containing this plotElement should be listening for changes in plotElement.plotDefaults, and can then decide if it wants to use the autorange settings. This also sets the style node of the plotElement copy, so its values should be sync'ed as well. This routine can be found by searching for "liver," since it is not the heart but pretty close to it.

Parameters:

peleCopy - the plot element.

props - metadata provided by the data source, converted to uniform QDataSet scheme (e.g. get(DEPEND_0).get(TYPICAL_MIN) )

fillDs - the dataset

ignoreDsProps -

getDasPlot

public DasPlot getDasPlot()

return the plot containing this plotElement's renderer, or null.

Returns:

the plot containing this plotElement's renderer, or null.

getDataSourceFilter

public DataSourceFilter getDataSourceFilter()

return the data source and filter for this plotElement.

Returns:

getApplication

public Application getApplication()

return the application that the plotElement belongs to.

Returns:

maybeCreateDasPeer

protected void maybeCreateDasPeer()

create the peer that will actually do the painting. This may be called from either the event thread or off the event thread, but work will be done on the event thread in either case using SwingUtilities.invokeAndWait. preconditions: the new render type is identified. The plotElement may already contain a corresponding renderer for this or another type. postconditions: The correct renderer is installed in the plot.

doResetRenderType

public void doResetRenderType(RenderType renderType)

used to explicitly set the rendering type. This installs a das2 renderer into the plot to implement the render type. preconditions: renderer type has been identified. postconditions: das2 renderer peer is created and bindings made.

Parameters:

renderType -

bindToSeriesRenderer

public void bindToSeriesRenderer(SeriesRenderer seriesRenderer)

bindToSpectrogramRenderer

public void bindToSpectrogramRenderer(SpectrogramRenderer spectrogramRenderer)

bindToImageVectorDataSetRenderer

public void bindToImageVectorDataSetRenderer(HugeScatterRenderer renderer)

bindToEventsRenderer

public void bindToEventsRenderer(EventsRenderer renderer)

bindToDigitalRenderer

public void bindToDigitalRenderer(DigitalRenderer renderer)

bindToPolarPlotRenderer

public void bindToPolarPlotRenderer(PolarPlotRenderer renderer)

bindToTickCurveRenderer

public void bindToTickCurveRenderer(TickCurveRenderer renderer)

bindToContoursRenderer

public void bindToContoursRenderer(Renderer renderer)

isPendingChanges

public boolean isPendingChanges()

Description copied from class: DomNodeController

Some sort of processing is going on, so wait until idle.

Overrides:

isPendingChanges in class DomNodeController

Returns:

true if there are changes pending.

pendingChanges

public void pendingChanges(java.util.Map<java.lang.Object,java.lang.Object> changes)

Description copied from class: DomNodeController

return a list of all the pending changes. These are returned in a Map that goes from pending change to change manager. Note this will recurse through all the children, so to see pending changes for the application, just call this on its controller.

Overrides:

pendingChanges in class DomNodeController

Parameters:

changes - a Map to which the changes will be added.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object