org.eclipse.eavp.viz.service.paraview

Class ParaViewPlot

java.lang.Object

org.eclipse.eavp.viz.service.AbstractPlot

org.eclipse.eavp.viz.service.connections.ConnectionPlot<IParaViewWebClient>

org.eclipse.eavp.viz.service.paraview.ParaViewPlot

All Implemented Interfaces:

IVizConnectionListener<IParaViewWebClient>, IPlot, IVizCanvas

public class ParaViewPlot
extends ConnectionPlot<IParaViewWebClient>

This class is responsible for embedding ParaView-supported graphics inside client Composites.

Instances of this class should not be created manually. Instead, a plot should be created via ConnectionVizService.createPlot(URI).

Author:

Jordan Deyton

See Also:

ParaViewVizService

Field Summary

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

DEFAULT_CATEGORY

Constructor Summary

Constructors

Constructor and Description
ParaViewPlot(ParaViewVizService vizService) The default constructor.

Method Summary

Modifier and Type	Method and Description
void	connectionStateChanged(IVizConnection<IParaViewWebClient> connection, ConnectionState state, java.lang.String message) Notifies the listener that the connection's state has changed.
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.ArrayList<org.eclipse.jface.action.Action>	getCustomActions() Get the list of Actions available to 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.
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.
boolean	setConnection(IVizConnection<IParaViewWebClient> connection) Sets the connection for this plot.
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.

Methods inherited from class org.eclipse.eavp.viz.service.connections.ConnectionPlot

draw

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

addPlotListener, getDataSource, getIndependentSeries, getNumberOfAxes, getPlotTitle, getProperties, getSourceHost, isSourceRemote, redraw, removePlotListener, save, saveAs, setPlotTitle, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

ParaViewPlot

public ParaViewPlot(ParaViewVizService vizService)

The default constructor.

Parameters:

vizService - The service used to create this plot.

Method Detail

connectionStateChanged

public void connectionStateChanged(IVizConnection<IParaViewWebClient> connection,
                                   ConnectionState state,
                                   java.lang.String message)

Description copied from interface: IVizConnectionListener

Notifies the listener that the connection's state has changed.

Specified by:

connectionStateChanged in interface IVizConnectionListener<IParaViewWebClient>

Overrides:

connectionStateChanged in class ConnectionPlot<IParaViewWebClient>

Parameters:

connection - The connection whose state changed.

state - The new state of the connection.

message - A descriptive message to go along with the state change. This is particularly useful if the connection failed.

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.

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.

setConnection

public boolean setConnection(IVizConnection<IParaViewWebClient> connection)
                      throws java.lang.Exception

Description copied from class: ConnectionPlot

Sets the connection for this plot.

Overrides:

setConnection in class ConnectionPlot<IParaViewWebClient>

Parameters:

connection - The new connection.

Returns:

True if the connection changed, false otherwise.

Throws:

java.lang.Exception - If the data source URI is set and the connection host does not match the URI's host.

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 ConnectionPlot<IParaViewWebClient>

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

Overrides:

setIndependentSeries in class AbstractPlot

Parameters:

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

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

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

Overrides:

getCustomActions in class AbstractPlot

Returns:

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

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.

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