org.autoplot.dom

Class Application

java.lang.Object

org.autoplot.dom.DomNode

org.autoplot.dom.Application

All Implemented Interfaces:

java.lang.Cloneable

public class Application
extends DomNode

Represents a state of the application as a whole, with its one canvas and multiple plots, axes, and bindings.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.CopyOnWriteArrayList<Annotation>	annotations
protected java.util.concurrent.CopyOnWriteArrayList<BindingModel>	bindings
protected java.util.concurrent.CopyOnWriteArrayList<Canvas>	canvases
protected java.util.concurrent.CopyOnWriteArrayList<Connector>	connectors
protected java.util.concurrent.CopyOnWriteArrayList<DataSourceFilter>	dataSourceFilters
static DatumRange	DEFAULT_TIME_RANGE default time range indicates when the range is not being used.
protected Options	options
protected java.util.concurrent.CopyOnWriteArrayList<PlotElement>	plotElements
protected java.util.concurrent.CopyOnWriteArrayList<Plot>	plots
static java.lang.String	PROP_ANNOTATIONS
static java.lang.String	PROP_BINDINGS
static java.lang.String	PROP_CANVASES
static java.lang.String	PROP_CONNECTORS
static java.lang.String	PROP_DATASOURCEFILTERS
static java.lang.String	PROP_EVENTSLISTURI
static java.lang.String	PROP_PLOT_ELEMENTS
static java.lang.String	PROP_PLOTS
static java.lang.String	PROP_TIMERANGE all time axes should hang off of this.
protected DatumRange	timeRange

Fields inherited from class org.autoplot.dom.DomNode

id, logger, PROP_ID, propertyChangeSupport

Constructor Summary

Constructors

Constructor and Description
Application()

Method Summary

Modifier and Type	Method and Description
java.util.List<DomNode>	childNodes() return any child nodes.
DomNode	copy() return a copy of this application state.
java.util.List<Diff>	diffs(DomNode node) List the differences between the two nodes.
Annotation[]	getAnnotations()
Annotation	getAnnotations(int index)
BindingModel[]	getBindings()
BindingModel	getBindings(int index)
Canvas[]	getCanvases()
Canvas	getCanvases(int index)
Connector[]	getConnectors()
Connector	getConnectors(int index)
ApplicationController	getController()
DataSourceFilter[]	getDataSourceFilters()
DataSourceFilter	getDataSourceFilters(int index)
DomNode	getElementById(java.lang.String id) return the DomNode referenced by id.
java.lang.String	getEventsListUri()
Options	getOptions()
PlotElement[]	getPlotElements()
PlotElement	getPlotElements(int index)
Plot[]	getPlots()
Plot	getPlots(int index)
DatumRange	getTimeRange()
void	setAnnotations(Annotation[] annotations)
void	setAnnotations(int index, Annotation annotation)
void	setBindings(BindingModel[] bindings)
void	setBindings(int index, BindingModel newBinding)
void	setCanvases(Canvas[] canvases)
void	setCanvases(int index, Canvas newCanvas)
void	setConnectors(Connector[] connectors)
void	setConnectors(int index, Connector newConnector)
void	setDataSourceFilters(DataSourceFilter[] dataSourceFilters)
void	setDataSourceFilters(int index, DataSourceFilter newDataSourceFilter)
void	setEventsListUri(java.lang.String eventsListUri)
void	setOptions(Options options)
void	setPlotElements(int index, PlotElement pele)
void	setPlotElements(PlotElement[] pele)
void	setPlots(int index, Plot newPlots)
void	setPlots(Plot[] plots)
void	setTimeRange(DatumRange timeRange)
void	syncTo(DomNode n) bulk assignment of properties.
void	syncTo(DomNode n, java.util.List<java.lang.String> exclude) Bulk assignment of properties, but allow specification of properties to exclude.

Methods inherited from class org.autoplot.dom.DomNode

addPropertyChangeListener, addPropertyChangeListener, boundCount, getId, removePropertyChangeListener, removePropertyChangeListener, setId, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIME_RANGE

public static final DatumRange DEFAULT_TIME_RANGE

default time range indicates when the range is not being used. This should never been seen by the user.

dataSourceFilters

protected java.util.concurrent.CopyOnWriteArrayList<DataSourceFilter> dataSourceFilters

PROP_DATASOURCEFILTERS

public static final java.lang.String PROP_DATASOURCEFILTERS

See Also:

Constant Field Values

PROP_PLOT_ELEMENTS

public static final java.lang.String PROP_PLOT_ELEMENTS

See Also:

Constant Field Values

plotElements

protected java.util.concurrent.CopyOnWriteArrayList<PlotElement> plotElements

PROP_PLOTS

public static final java.lang.String PROP_PLOTS

See Also:

Constant Field Values

plots

protected java.util.concurrent.CopyOnWriteArrayList<Plot> plots

PROP_CANVASES

public static final java.lang.String PROP_CANVASES

See Also:

Constant Field Values

canvases

protected java.util.concurrent.CopyOnWriteArrayList<Canvas> canvases

PROP_ANNOTATIONS

public static final java.lang.String PROP_ANNOTATIONS

See Also:

Constant Field Values

annotations

protected java.util.concurrent.CopyOnWriteArrayList<Annotation> annotations

options

protected Options options

timeRange

protected DatumRange timeRange

PROP_TIMERANGE

public static final java.lang.String PROP_TIMERANGE

all time axes should hang off of this.

See Also:

Constant Field Values

PROP_EVENTSLISTURI

public static final java.lang.String PROP_EVENTSLISTURI

See Also:

Constant Field Values

PROP_BINDINGS

public static final java.lang.String PROP_BINDINGS

See Also:

Constant Field Values

bindings

protected java.util.concurrent.CopyOnWriteArrayList<BindingModel> bindings

PROP_CONNECTORS

public static final java.lang.String PROP_CONNECTORS

See Also:

Constant Field Values

connectors

protected java.util.concurrent.CopyOnWriteArrayList<Connector> connectors

Constructor Detail

Application

public Application()

Method Detail

getDataSourceFilters

public DataSourceFilter[] getDataSourceFilters()

setDataSourceFilters

public void setDataSourceFilters(DataSourceFilter[] dataSourceFilters)

getDataSourceFilters

public DataSourceFilter getDataSourceFilters(int index)

setDataSourceFilters

public void setDataSourceFilters(int index,
                                 DataSourceFilter newDataSourceFilter)

getPlotElements

public PlotElement[] getPlotElements()

setPlotElements

public void setPlotElements(PlotElement[] pele)

getPlotElements

public PlotElement getPlotElements(int index)

setPlotElements

public void setPlotElements(int index,
                            PlotElement pele)

getPlots

public Plot[] getPlots()

setPlots

public void setPlots(Plot[] plots)

getPlots

public Plot getPlots(int index)

setPlots

public void setPlots(int index,
                     Plot newPlots)

getCanvases

public Canvas[] getCanvases()

setCanvases

public void setCanvases(Canvas[] canvases)

getCanvases

public Canvas getCanvases(int index)

setCanvases

public void setCanvases(int index,
                        Canvas newCanvas)

getAnnotations

public Annotation[] getAnnotations()

setAnnotations

public void setAnnotations(Annotation[] annotations)

getAnnotations

public Annotation getAnnotations(int index)

setAnnotations

public void setAnnotations(int index,
                           Annotation annotation)

getController

public ApplicationController getController()

getOptions

public Options getOptions()

setOptions

public void setOptions(Options options)

getTimeRange

public DatumRange getTimeRange()

setTimeRange

public void setTimeRange(DatumRange timeRange)

getEventsListUri

public java.lang.String getEventsListUri()

setEventsListUri

public void setEventsListUri(java.lang.String eventsListUri)

getBindings

public BindingModel[] getBindings()

setBindings

public void setBindings(BindingModel[] bindings)

getBindings

public BindingModel getBindings(int index)

setBindings

public void setBindings(int index,
                        BindingModel newBinding)

getConnectors

public Connector[] getConnectors()

setConnectors

public void setConnectors(Connector[] connectors)

getConnectors

public Connector getConnectors(int index)

setConnectors

public void setConnectors(int index,
                          Connector newConnector)

copy

public DomNode copy()

return a copy of this application state.

Overrides:

copy in class DomNode

Returns:

a copy of this application state.

childNodes

public java.util.List<DomNode> childNodes()

Description copied from class: DomNode

return any child nodes.

Overrides:

childNodes in class DomNode

Returns:

syncTo

public void syncTo(DomNode n)

Description copied from class: DomNode

bulk assignment of properties. When the node's children differ, then a controller should be used to implement the sync. Syncing should include the node's ID.

Overrides:

syncTo in class DomNode

syncTo

public void syncTo(DomNode n,
                   java.util.List<java.lang.String> exclude)

Description copied from class: DomNode

Bulk assignment of properties, but allow specification of properties to exclude. Note exclude should be passed to children when this is overriden, normally to exclude id property.

Overrides:

syncTo in class DomNode

diffs

public java.util.List<Diff> diffs(DomNode node)

List the differences between the two nodes. These should always be from this to that. TODO: somehow this ends up working, although PlotElement and Style don't follow this rule.

Overrides:

diffs in class DomNode

Parameters:

node -

Returns:

getElementById

public DomNode getElementById(java.lang.String id)

return the DomNode referenced by id. This was introduced because it is often difficult to identify the index of a plot in the plots array but its id is known, and this avoids the import of DomUtil.

Parameters:

id - an id, such as "plot_2"

Returns:

the node

Throws:

java.lang.IllegalArgumentException - if the id is not found.

See Also:

DomUtil.getElementById(org.autoplot.dom.DomNode, java.lang.String)