org.eclipse.eavp.viz.service

Interface IVizServiceFactory

All Known Implementing Classes:

BasicVizServiceFactory

public interface IVizServiceFactory

This is a pluggable service interface for managing a collection of visualization engines that have been published to the platform. Implementations of this interface should be relatively straightforward, simple classes that index all of the IVizServices registered to the factory.

Author:

Jay Jay Billings

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	unregister(IVizService service) This operation unregisters an IVizService with the factory so that it will no longer be used by clients.

Method Detail

get

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.

Returns:

The default IVizService or null if no service is available

get

IVizService get(java.lang.String serviceName)

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.

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

java.lang.String[] getServiceNames()

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.

Returns:

The names of the registered services

register

void register(IVizService service)

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.

Parameters:

service - The visualization service to register

unregister

void unregister(IVizService service)

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

Parameters:

service - The visualization service to register