public interface IVizService
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.)
Modifier and Type | Method and Description |
---|---|
boolean |
connect()
This operation directs the IVizService to "connect" to any pieces of its
service that may not already be running or require additional
configuration at run time.
|
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.
|
boolean |
disconnect()
This operation directs the IVizService to "disconnect" any currently
running pieces of its service that may be running.
|
java.util.Map<java.lang.String,java.lang.String> |
getConnectionProperties()
This operation returns the current set of connection properties for the
IVizService.
|
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.
|
boolean |
hasConnectionProperties()
This operation tells whether or not the IVizService has connection
properties.
|
void |
setConnectionProperties(java.util.Map<java.lang.String,java.lang.String> props)
This operation updates the connection properties based on updates from a
client.
|
java.lang.String getName()
java.lang.String getVersion()
boolean hasConnectionProperties()
java.util.Map<java.lang.String,java.lang.String> getConnectionProperties()
The contents of the properties are up to the IVizService implementation
void setConnectionProperties(java.util.Map<java.lang.String,java.lang.String> props)
If the IVizService does not require a connection to other components, it may ignore this operation.
props
- The new property valuesboolean connect()
Each IVizService that requires a connection should provide a "best guess" at initial connection properties and if the properties are not updated a call to connect() should attempt to connect using the default properties.
boolean disconnect()
IPlot createPlot(java.net.URI file) throws java.lang.Exception
file
- The file from which the plot should be createde
- An exception indicating that the IVizService could not create
a plot with the given file and giving the reason why.java.lang.Exception