org.eclipse.eavp.viz.service.csv

Class CSVVizService

java.lang.Object

org.eclipse.eavp.viz.service.AbstractVizService

org.eclipse.eavp.viz.service.csv.CSVVizService

All Implemented Interfaces:

IVizService

public class CSVVizService
extends AbstractVizService

This class implements the IVizService interface to provide CSV plotting tools to the platform via the IVizServiceFactory. It used the classes already available in org.eclipse.eavp.viz and provides a rudimentary plotting capability. It is the default "ice-plot" implementation provided by the platform.

Author:

Jay Jay Billings

Constructor Summary

Constructors

Constructor and Description
CSVVizService() The default constructor.

Method Summary

Modifier and Type	Method and Description
IVizCanvas	createCanvas(Geometry geometry) This operation directs the IVizService to create a new canvas displaying the given Geometry and to return a handle to that canvas to the caller so that it may modify the canvas.
IVizCanvas	createCanvas(IController object) Nothing to do for the basic implementation for creating a canvas.
IPlot	createPlot(java.net.URI file) This class provides a basic implementation where an IllegalArgumentException is thrown if the specified URI or its associated file's extension is invalid.
IControllerProviderFactory	getControllerProviderFactory() Returns a factory which will create views and controllers for model parts specific to the service's rendering program.
java.lang.String	getName() This operation returns the name of the service.
java.lang.String	getVersion() This operation returns a version number for the service.

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

getSupportedExtensions

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVVizService

public CSVVizService()

The default constructor.

Note: Only OSGi should call this method!

Method Detail

createPlot

public IPlot createPlot(java.net.URI file)
                 throws java.lang.Exception

Description copied from class: AbstractVizService

This class provides a basic implementation where an IllegalArgumentException is thrown if the specified URI or its associated file's extension is invalid.

It is recommended that sub-classes override this method but call it in the first line. Sub-classes should also add supported extensions to the set of AbstractVizService.supportedExtensions at construction.

Specified by:

createPlot in interface IVizService

Overrides:

createPlot in class AbstractVizService

Parameters:

file - The file from which the plot should be created

Returns:

The IPlot that will render a plot from the file

Throws:

java.lang.Exception - An exception indicating that the IVizService could not create a plot with the given file and giving the reason why.

getName

public java.lang.String getName()

Description copied from interface: IVizService

This operation returns the name of the service. The name should be something simple and human-readable.

Returns:

The name of the IVizService

getVersion

public java.lang.String getVersion()

Description copied from interface: IVizService

This operation returns a version number for the service. It should be more or less human readable and contain a major and a minor version (Version 2.1 instead of just 2, for example).

Returns:

The version of the IVizService

createCanvas

public IVizCanvas createCanvas(IController object)
                        throws java.lang.Exception

Description copied from class: AbstractVizService

Nothing to do for the basic implementation for creating a canvas.

Specified by:

createCanvas in interface IVizService

Overrides:

createCanvas in class AbstractVizService

Parameters:

object - The input object which will be rendered in the new canvas

Returns:

The IVizCanvas that will render the object

Throws:

java.lang.Exception - An exception indicating that the IVizService could not create a canvas with the given object and giving the reason why.

getControllerProviderFactory

public IControllerProviderFactory getControllerProviderFactory()

Description copied from interface: IVizService

Returns a factory which will create views and controllers for model parts specific to the service's rendering program.

Returns:

A factory that will create controllers compatible with this service

createCanvas

public IVizCanvas createCanvas(Geometry geometry)
                        throws java.lang.Exception

Description copied from interface: IVizService

This operation directs the IVizService to create a new canvas displaying the given Geometry and to return a handle to that canvas to the caller so that it may modify the canvas.

Parameters:

geometry - The input object which will be rendered in the new canvas.

Returns:

The IVizCanvas that will render the object

Throws:

java.lang.Exception - An exception indicating that the IVizService could not create a canvas with the given object and giving the reason why.