org.eclipse.eavp.viz.service

Class AbstractVizService

java.lang.Object

org.eclipse.eavp.viz.service.AbstractVizService

All Implemented Interfaces:

IVizService

Direct Known Subclasses:

ConnectionVizService, CSVVizService, FXGeometryVizService, FXMeshVizService

public abstract class AbstractVizService
extends java.lang.Object
implements IVizService

This is an abstract base class for creating new IVizServices and includes helpful methods that are frequently used.

In particular this abstract class provides the following basic functionality:

• It provides access to a preference store based on the sub-class and its bundle.
• It maintains a set of supported extensions that is lazily loaded when necessary.
• When createPlot(URI) is called, this checks that the URI is not null and that its extension is supported.

Author:

Jordan Deyton

Constructor Summary

Constructors

Constructor and Description
AbstractVizService()

Method Summary

Modifier and Type	Method and Description
IVizCanvas	createCanvas(IController object) Nothing to do for the basic implementation for creating a canvas.
IPlot	createPlot(java.net.URI uri) This class provides a basic implementation where an IllegalArgumentException is thrown if the specified URI or its associated file's extension is invalid.
java.util.Set<java.lang.String>	getSupportedExtensions() Gets a set containing all supported file extensions for which an IPlot can be created.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.eavp.viz.service.IVizService

createCanvas, getControllerProviderFactory, getName, getVersion

Constructor Detail

AbstractVizService

public AbstractVizService()

Method Detail

createPlot

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

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 supportedExtensions at construction.

Specified by:

createPlot in interface IVizService

Parameters:

uri - 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.

createCanvas

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

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

Specified by:

createCanvas in interface IVizService

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.

getSupportedExtensions

public java.util.Set<java.lang.String> getSupportedExtensions()

Description copied from interface: IVizService

Gets a set containing all supported file extensions for which an IPlot can be created. Extensions in the set are expected to conform to the following format:

• simple (tar and gz, but not tar.gz),
• should not include the leading period (doc, not .doc), and
• should be lower case (txt, not TXT).

Specified by:

getSupportedExtensions in interface IVizService

Returns:

A set containing all supported extensions.