IVizService

All Known Implementing Classes:

AbstractVizService, ConnectionVizService, CSVVizService, FakeVizService, FXGeometryVizService, FXMeshVizService, ParaViewVizService, VisItVizService
```
public interface IVizService
```
This is a pluggable service interface whereby visualization engines can publish their services to the platform. It is designed to be implemented as a pluggable, declarative OSGi service that is provided dynamically to an implementation of the IVizServiceFactory.
IVizServices should be considered handles to the services that a particular visualization engine provides. Its primary purpose a means to configure a valid connection to the visualization service, if required, and to act as a factory for creating IPlots.

IVizServices are responsible for managing their own preferences and providing both an IPreferencesPage that can be registered with the Platform and a simple map of preferences. (The simplest way to do this is to keep everything in a bundle preferences store, register listeners on the page, and handle merges from setConnectionProperties manually.)

Author:

Jay Jay Billings, Robert Smith, Kasper Gammeltoft, Jordan Deyton

Method Summary

All Methods Instance Methods Abstract Methods
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)` This operation directs the IVizService to create a new canvas using the given VizObject and to return a handle to that canvas to the caller so that it may modify the canvas.
`IPlot`	`createPlot(java.net.URI file)` This operation directs the IVizService to create a new plot using the specified file and to return a handle to that plot to the caller so that it may modify the plot.
`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.util.Set<java.lang.String>`	`getSupportedExtensions()` Gets a set containing all supported file extensions for which an IPlot can be created.
`java.lang.String`	`getVersion()` This operation returns a version number for the service.

- Method Detail
  - createCanvas
```
IVizCanvas createCanvas(IController object)
                 throws java.lang.Exception
```
    This operation directs the IVizService to create a new canvas using the given VizObject and to return a handle to that canvas to the caller so that it may modify the canvas.
    
    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.
  - createCanvas
```
IVizCanvas createCanvas(Geometry geometry)
                 throws java.lang.Exception
```
    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.
  - getControllerProviderFactory
```
IControllerProviderFactory getControllerProviderFactory()
```
    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
  - getName
```
java.lang.String getName()
```
    This operation returns the name of the service. The name should be something simple and human-readable.
    
    Returns:
    
    The name of the IVizService
  - getVersion
```
java.lang.String getVersion()
```
    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
  - createPlot
```
IPlot createPlot(java.net.URI file)
          throws java.lang.Exception
```
    This operation directs the IVizService to create a new plot using the specified file and to return a handle to that plot to the caller so that it may modify the plot.
    
    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.
  - getSupportedExtensions
```
java.util.Set<java.lang.String> getSupportedExtensions()
```
    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).
    Returns:
    
    A set containing all supported extensions.

Interface IVizService

Method Summary

Method Detail

createCanvas

createCanvas

getControllerProviderFactory

getName

getVersion

createPlot

getSupportedExtensions