org.eclipse.eavp.viz.service.csv

Class CSVPlot

java.lang.Object

org.eclipse.eavp.viz.service.AbstractPlot

org.eclipse.eavp.viz.service.csv.CSVPlot

All Implemented Interfaces:

IPlot, IVizCanvas

public class CSVPlot
extends AbstractPlot

This class implements the IPlot interface to provide access to a basic CSV plot using the existing CSV infrastructure in ICE. In addition to the IPlot operations it provides the load() operation that should be called after construction if you want to take the data and series information from the specified URI. Otherwise, it is necessary to manually add the series information. This second option is required to set custom settings for this plot, specifically for the style of the series and specifying which one is the independent variable.

Author:

Jay Jay Billings, Anna Wojtowicz, Alex McCaskey, Kasper Gammeltoft- Updated to extend MultiPlot, added ISeries functionality, updated to use CSVPlotRenders rather than DrawnPlots.

Field Summary

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

DEFAULT_CATEGORY

Constructor Summary

Constructors

Constructor and Description
CSVPlot() The default constructor.

Method Summary

Modifier and Type	Method and Description
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.
java.util.List<java.lang.String>	getCategories() Gets all of the categories currently associated with this plot.
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.
int	getNumAdditionalPages() Gets the number of pages this service will display in the plot editor in addition to the main canvas.
int	getNumberOfAxes() Always returns two as CSV plots are always 2D
IRenderElementHolder	getRenderElementHolder(Geometry geometry) Get the list of render elements used to display the given geometry in this canvas.
boolean	isLoaded() Gets whether or not data has been loaded from the data source.
void	load() This operation loads the data that will be plotted.
void	redraw() This operation directs the IPlot to redraw its contents.
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.

Methods inherited from class org.eclipse.eavp.viz.service.AbstractPlot

addPlotListener, draw, getCustomActions, getDataSource, getIndependentSeries, getPlotTitle, getProperties, getSourceHost, isSourceRemote, removePlotListener, setIndependentSeries, setPlotTitle, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVPlot

public CSVPlot()

The default constructor.

Method Detail

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

Overrides:

createAdditionalPage in class AbstractPlot

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

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

Overrides:

getCategories in class AbstractPlot

Returns:

The categories for this plot.

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

Overrides:

getDependentSeries in class AbstractPlot

Returns:

List all of the dependent series to be plotted.

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

Overrides:

getNumAdditionalPages in class AbstractPlot

Returns:

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

getNumberOfAxes

public int getNumberOfAxes()

Always returns two as CSV plots are always 2D

Specified by:

getNumberOfAxes in interface IVizCanvas

Overrides:

getNumberOfAxes in class AbstractPlot

Returns:

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

See Also:

IVizCanvas.getNumberOfAxes()

isLoaded

public boolean isLoaded()

Gets whether or not data has been loaded from the data source.

Returns:

True if data has been loaded, false otherwise.

load

public void load()

This operation loads the data that will be plotted. It uses a separate thread to avoid hanging the UI in the event that the file is large. It does not attempt to load the file if the source is null.

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

Overrides:

redraw in class AbstractPlot

setDataSource

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

Description copied from class: AbstractPlot

Sets the URI for this plot.

Overrides:

setDataSource in class AbstractPlot

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.

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

Overrides:

save in class AbstractPlot

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

Overrides:

saveAs in class AbstractPlot

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

Overrides:

getRenderElementHolder in class AbstractPlot

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()