org.eclipse.eavp.viz.service

Class BasicVizServiceFactory

java.lang.Object

org.eclipse.eavp.viz.service.BasicVizServiceFactory

All Implemented Interfaces:

IVizServiceFactory

public class BasicVizServiceFactory
extends java.lang.Object
implements IVizServiceFactory

This class is the basic implementation of the IVizServiceFactory in ICE. It is registered with the platform as an OSGi service. The default IVizService is "ice-plot" and it is registered when the service is started.

Author:

Jay Jay Billings

Constructor Summary

Constructors

Constructor and Description
BasicVizServiceFactory() The constructor

Method Summary

Modifier and Type	Method and Description
IVizService	get() This operation returns the default IVizService provided by the factory, which is entirely up to the factory, or null if the factory does not contain a default service.
IVizService	get(java.lang.String serviceName) This operation returns the IVizService with the given name or null it if is unavailable.
java.lang.String[]	getServiceNames() This operation returns the names of all of the IVizServices registered with the factory.
void	register(IVizService service) This operation registers an IVizService with the factory so that it can be retrieved and used by clients.
void	start() This operation starts the service, including registering the basic CSV plotter viz service, "ice-plot," with the platform.
void	unregister(IVizService service) This operation unregisters an IVizService with the factory so that it will no longer be used by clients.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicVizServiceFactory

public BasicVizServiceFactory()

The constructor

Method Detail

get

public IVizService get()

Description copied from interface: IVizServiceFactory

This operation returns the default IVizService provided by the factory, which is entirely up to the factory, or null if the factory does not contain a default service.

Specified by:

get in interface IVizServiceFactory

Returns:

The default IVizService or null if no service is available

get

public IVizService get(java.lang.String serviceName)

Description copied from interface: IVizServiceFactory

This operation returns the IVizService with the given name or null it if is unavailable. It is the preferred way of retrieving an IVizService because it is explicit in what needs to be retrieved.

Specified by:

get in interface IVizServiceFactory

Parameters:

serviceName - The name of the service to find

Returns:

The visualization service with the given name or null if that service cannot be found by the factory

getServiceNames

public java.lang.String[] getServiceNames()

Description copied from interface: IVizServiceFactory

This operation returns the names of all of the IVizServices registered with the factory. It is makes it possible to give clients a choice of services instead of relying on the default service or guessing at what may be registered.

Specified by:

getServiceNames in interface IVizServiceFactory

Returns:

The names of the registered services

register

public void register(IVizService service)

Description copied from interface: IVizServiceFactory

This operation registers an IVizService with the factory so that it can be retrieved and used by clients.

The factory will register the IVizService's preference page with the platform when this operation is called and if the IVizService has properties.

Specified by:

register in interface IVizServiceFactory

Parameters:

service - The visualization service to register

start

public void start()

This operation starts the service, including registering the basic CSV plotter viz service, "ice-plot," with the platform.

unregister

public void unregister(IVizService service)

Description copied from interface: IVizServiceFactory

This operation unregisters an IVizService with the factory so that it will no longer be used by clients.

Specified by:

unregister in interface IVizServiceFactory

Parameters:

service - The visualization service to register