org.eclipse.eavp.viz.service.csv

Class CSVProxyPlot

java.lang.Object

org.eclipse.eavp.viz.service.AbstractPlot

org.eclipse.eavp.viz.service.ProxyPlot

org.eclipse.eavp.viz.service.csv.CSVProxyPlot

All Implemented Interfaces:

IPlot, IPlotListener, IVizCanvas

public class CSVProxyPlot
extends ProxyPlot
implements IPlotListener

This class serves as a proxy for a normal CSVPlot, which is itself responsible for loading and storing the CSV data. Instances of this class are provided from the CSVVizService when a plot is created, and it gives full access to customizing a plot without affecting the data source plot.

Author:

Jordan Deyton

Field Summary

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

DEFAULT_CATEGORY

Constructor Summary

Constructors

Constructor and Description
CSVProxyPlot()

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.
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.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.
IRenderElementHolder	getRenderElementHolder(Geometry geometry) Get the list of render elements used to display the given geometry in this canvas.
void	plotUpdated(IPlot plot, java.lang.String key, java.lang.String value) Notifies the listener that the plot has been updated along with state information that the listener may be able to use.
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.
void	setIndependentSeries(ISeries series) Sets the series that will be on the independent axis for this plot.
void	setSource(IPlot source) Sets the source IPlot on which this plot is based.

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

getDataSource, getNumberOfAxes

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

addPlotListener, getCustomActions, getPlotTitle, getProperties, getSourceHost, isSourceRemote, removePlotListener, setDataSource, setPlotTitle, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVProxyPlot

public CSVProxyPlot()

Method Detail

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

Overrides:

draw in class AbstractPlot

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

Overrides:

getCategories in class ProxyPlot

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 ProxyPlot

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

Overrides:

getIndependentSeries in class AbstractPlot

Returns:

ISeries the independent series.

plotUpdated

public void plotUpdated(IPlot plot,
                        java.lang.String key,
                        java.lang.String value)

Description copied from interface: IPlotListener

Notifies the listener that the plot has been updated along with state information that the listener may be able to use.

Specified by:

plotUpdated in interface IPlotListener

Parameters:

plot - The plot that was updated.

key - The key for the update event that occurred.

value - An associated value for the update event that occurred.

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

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

Overrides:

setIndependentSeries in class AbstractPlot

Parameters:

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

setSource

public void setSource(IPlot source)

Description copied from class: ProxyPlot

Sets the source IPlot on which this plot is based. This method synchronizes this plot's dependent series with those of the original plot by creating a ProxySeries to those of the source plot.

Overrides:

setSource in class ProxyPlot

Parameters:

source - The source plot. If null, the source will be unset and all dependent series will be cleared.

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

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.

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