org.eclipse.eavp.viz.service

Class AbstractPlot

java.lang.Object

org.eclipse.eavp.viz.service.AbstractPlot

All Implemented Interfaces:

IPlot, IVizCanvas

Direct Known Subclasses:

ConnectionPlot, CSVPlot, ProxyPlot

public abstract class AbstractPlot
extends java.lang.Object
implements IPlot

This class provides a basic, limited implementation of certain features of IPlot. This class does not manage the data source, categories, or dependent series. It also does not handle drawing the plot.

Author:

Jordan Deyton

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.service.IPlot

DEFAULT_CATEGORY

Constructor Summary

Constructors

Constructor and Description
AbstractPlot()

Method Summary

Modifier and Type	Method and Description
boolean	addPlotListener(IPlotListener listener) Adds the specified listener to the plot to receive updates.
java.lang.String	createAdditionalPage(org.eclipse.ui.part.MultiPageEditorPart parent, org.eclipse.ui.IFileEditorInput file, int pageNum) Directs the service to draw one of its additional pages and add it to the MultiPageEditorPart.
org.eclipse.swt.widgets.Composite	draw(org.eclipse.swt.widgets.Composite parent) This operation draws the canvas contents onto the given parent Composite.
java.util.List<java.lang.String>	getCategories() Gets all of the categories currently associated with this plot.
java.util.ArrayList<org.eclipse.jface.action.Action>	getCustomActions() Get the list of Actions available to this plot.
java.net.URI	getDataSource() This operation returns the data source that is plotted/drawn by this IPlot.
java.util.List<ISeries>	getDependentSeries(java.lang.String category) Gets all of the dependent series specified for this IPlot, as a list, for the specified category.
ISeries	getIndependentSeries() Gets the independent series for the plot.
int	getNumAdditionalPages() Gets the number of pages this service will display in the plot editor in addition to the main canvas.
int	getNumberOfAxes() This operation returns the number of axes of the plot.
java.lang.String	getPlotTitle() Gets the title of the plot to be displayed in whatever visualization service is rendering this plot
java.util.Map<java.lang.String,java.lang.String>	getProperties() This operation returns properties of this IPlot that can be safely modified and/or tuned by the client.
IRenderElementHolder	getRenderElementHolder(Geometry geometry) Get the list of render elements used to display the given geometry in this canvas.
java.lang.String	getSourceHost() This operation retrieves the hostname for this IPlot's data source.
boolean	isSourceRemote() This operation signifies whether or not the IPlot's host is local or remote.
void	redraw() This operation directs the IPlot to redraw its contents.
boolean	removePlotListener(IPlotListener listener) Removes the specified listener from receiving plot update events.
void	save(org.eclipse.core.runtime.IProgressMonitor monitor) Save the contents of the plot to the source file.
void	saveAs() Open a dialog to save the plot's contents.
boolean	setDataSource(java.net.URI uri) Sets the URI for this plot.
void	setIndependentSeries(ISeries series) Sets the series that will be on the independent axis for this plot.
void	setPlotTitle(java.lang.String title) Sets the title of the plot to the specified string.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> props) This operation updates the properties of the plot based on client-side modifications.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractPlot

public AbstractPlot()

Method Detail

addPlotListener

public boolean addPlotListener(IPlotListener listener)

Adds the specified listener to the plot to receive updates. The same listener cannot be added twice.

Parameters:

listener - The listener to add. null cannot be added.

Returns:

True if the listener was added, false otherwise.

getRenderElementHolder

public IRenderElementHolder getRenderElementHolder(Geometry geometry)

Description copied from interface: IVizCanvas

Get the list of render elements used to display the given geometry in this canvas.

Specified by:

getRenderElementHolder in interface IVizCanvas

Parameters:

geometry - The geometry whose corresponding IRenderElements are sought.

Returns:

An array list of each of the top level IRenderElements in the hierarchy, corresponding to the geometry's nodes list from getNodes()

draw

public org.eclipse.swt.widgets.Composite draw(org.eclipse.swt.widgets.Composite parent)
                                       throws java.lang.Exception

Description copied from interface: IVizCanvas

This operation draws the canvas contents onto the given parent Composite. The exact details of how the plot is drawn and what is drawn inside the parent composite are left completely up to the implementation.

Specified by:

draw in interface IVizCanvas

Throws:

java.lang.Exception

getCategories

public java.util.List<java.lang.String> getCategories()

Description copied from interface: IPlot

Gets all of the categories currently associated with this plot.

Specified by:

getCategories in interface IPlot

Returns:

The categories for this plot.

getCustomActions

public java.util.ArrayList<org.eclipse.jface.action.Action> getCustomActions()

Description copied from interface: IPlot

Get the list of Actions available to this plot. These are intended to be used to populate the plot editor's toolbar with custom buttons specific to the plot type.

Specified by:

getCustomActions in interface IPlot

Returns:

A list of Actions which the IPlot can be directed to perform.

getDataSource

public java.net.URI getDataSource()

Description copied from interface: IVizCanvas

This operation returns the data source that is plotted/drawn by this IPlot.

Specified by:

getDataSource in interface IVizCanvas

Returns:

The data source

getDependentSeries

public java.util.List<ISeries> getDependentSeries(java.lang.String category)

Description copied from interface: IPlot

Gets all of the dependent series specified for this IPlot, as a list, for the specified category. If the category is null, will return the default category.

Specified by:

getDependentSeries in interface IPlot

Returns:

List all of the dependent series to be plotted.

getIndependentSeries

public ISeries getIndependentSeries()

Description copied from interface: IPlot

Gets the independent series for the plot. This is the series that all the other series should be plotted against.

Specified by:

getIndependentSeries in interface IPlot

Returns:

ISeries the independent series.

getNumberOfAxes

public int getNumberOfAxes()

Description copied from interface: IVizCanvas

This operation returns the number of axes of the plot.

Specified by:

getNumberOfAxes in interface IVizCanvas

Returns:

The number of axes or zero if the plot has not been drawn

getPlotTitle

public java.lang.String getPlotTitle()

Description copied from interface: IPlot

Gets the title of the plot to be displayed in whatever visualization service is rendering this plot

Specified by:

getPlotTitle in interface IPlot

Returns:

String The plot title

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Description copied from interface: IVizCanvas

This operation returns properties of this IPlot that can be safely modified and/or tuned by the client. These properties should contains things such as, for example, the axis labels, the title, the subtitle, etc.

Specified by:

getProperties in interface IVizCanvas

Returns:

A map of the properties.

getSourceHost

public java.lang.String getSourceHost()

Description copied from interface: IVizCanvas

This operation retrieves the hostname for this IPlot's data source.

Specified by:

getSourceHost in interface IVizCanvas

Returns:

the hostname

isSourceRemote

public boolean isSourceRemote()

Description copied from interface: IVizCanvas

This operation signifies whether or not the IPlot's host is local or remote.

Specified by:

isSourceRemote in interface IVizCanvas

Returns:

True if the source is on a remote machine, false otherwise

redraw

public void redraw()

Description copied from interface: IVizCanvas

This operation directs the IPlot to redraw its contents. This can be invoked when, for example, the data represented by this IPlot changes, and a change in the IPlot's UI must change accordingly. The exact details of how this IPlot is redrawn after a valid draw is left completely to the implementation.

Specified by:

redraw in interface IVizCanvas

removePlotListener

public boolean removePlotListener(IPlotListener listener)

Removes the specified listener from receiving plot update events.

Parameters:

listener - The listener to remove.

Returns:

True if the listener was removed, false otherwise (including if it was not a listener).

setDataSource

public boolean setDataSource(java.net.URI uri)
                      throws java.lang.Exception

Sets the URI for this plot.

Parameters:

uri - The new data source URI.

Returns:

True if the data source changed.

Throws:

java.lang.Exception - If there was an error setting the data source.

setIndependentSeries

public void setIndependentSeries(ISeries series)

Description copied from interface: IPlot

Sets the series that will be on the independent axis for this plot. All other series will be plotted in reference to this series.

Specified by:

setIndependentSeries in interface IPlot

Parameters:

series - The independent series, used to plot the other independent series

setPlotTitle

public void setPlotTitle(java.lang.String title)

Description copied from interface: IPlot

Sets the title of the plot to the specified string.

Specified by:

setPlotTitle in interface IPlot

Parameters:

title - The new title for this plot

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> props)
                   throws java.lang.Exception

Description copied from interface: IVizCanvas

This operation updates the properties of the plot based on client-side modifications. The IPlot should redraw itself as needed if the properties changed.

Specified by:

setProperties in interface IVizCanvas

Parameters:

props - The updated properties

Throws:

java.lang.Exception - This exception indicates that the IPlot could not update its properties or redraw itself.

createAdditionalPage

public java.lang.String createAdditionalPage(org.eclipse.ui.part.MultiPageEditorPart parent,
                                             org.eclipse.ui.IFileEditorInput file,
                                             int pageNum)

Description copied from interface: IPlot

Directs the service to draw one of its additional pages and add it to the MultiPageEditorPart. The expected use is to call creatAddionalPage(parent, file, 1), createAdditonalPage(parent, file, 2), etc. until all additional pages have been drawn in separate tabs.

Specified by:

createAdditionalPage in interface IPlot

Parameters:

parent - The part which the page will be added to.

file - The file to use as input for the page.

pageNum - The id of the page to be drawn.

Returns:

The name of the new page, to be displayed as the title of the tab containing it

getNumAdditionalPages

public int getNumAdditionalPages()

Description copied from interface: IPlot

Gets the number of pages this service will display in the plot editor in addition to the main canvas.

Specified by:

getNumAdditionalPages in interface IPlot

Returns:

The number of additional pages displayed by the plot editor. 0 if there is only one page.

save

public void save(org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IPlot

Save the contents of the plot to the source file.

Specified by:

save in interface IPlot

Parameters:

monitor - The monitor for the save action's progress.

saveAs

public void saveAs()

Description copied from interface: IPlot

Open a dialog to save the plot's contents.

Specified by:

saveAs in interface IPlot