org.eclipse.eavp.viz.service.paraview.proxy

Interface IParaViewProxyFactory

All Known Implementing Classes:

ParaViewProxyFactory

public interface IParaViewProxyFactory

Implementations of this interface provide a factory that maps supported extensions for files to IParaViewProxyBuilder instances. Client code can request a builder by calling #getProxyBuilder(URI).

This interface is designed to be provided and referenced via OSGi.

Author:

Jordan Deyton

Method Summary

Modifier and Type	Method and Description
IParaViewProxy	createProxy(java.net.URI uri) Gets a proxy for the provided file based on its extension.
java.util.Set<java.lang.String>	getExtensions() Gets the set of supported extensions for all registered proxy builders.
boolean	registerProxyBuilder(IParaViewProxyBuilder builder) Registers a new proxy builder using the builder's supported extensions.
boolean	unregisterProxyBuilder(IParaViewProxyBuilder builder) Unregisters the specified proxy builder.

Method Detail

createProxy

IParaViewProxy createProxy(java.net.URI uri)
                    throws java.lang.NullPointerException,
                           java.lang.IllegalArgumentException

Gets a proxy for the provided file based on its extension.

Parameters:

uri - The file for which a proxy will be created.

Returns:

A proxy for the specified file. This proxy is used to interact with the file through a ParaView server.

Throws:

java.lang.NullPointerException - If the specified URI is null.

java.lang.IllegalArgumentException - If the specified URI's extension is not supported.

getExtensions

java.util.Set<java.lang.String> getExtensions()

Gets the set of supported extensions for all registered proxy builders. Note that duplicate extensions are not to be listed. The extensions should not include the leading period.

Returns:

The set of supported extensions for all proxy builders. This should never be null, and should not change throughout the factory's lifecycle, as builders will be registered via OSGi.

registerProxyBuilder

boolean registerProxyBuilder(IParaViewProxyBuilder builder)

Registers a new proxy builder using the builder's supported extensions.

This method will usually be called by OSGi.

Parameters:

builder - The builder to register. If null, nothing is registered.

Returns:

True if the provided builder was registered, false otherwise (including the case where the builder has no supported extensions).

unregisterProxyBuilder

boolean unregisterProxyBuilder(IParaViewProxyBuilder builder)

Unregisters the specified proxy builder. Its extensions should no longer be supported if it is the only builder for said extensions.

This method will usually be called by OSGi.

Parameters:

builder - The builder to unregister. If null, nothing is unregistered.

Returns:

True if the provided builder was unregistered, false otherwise (including the case where the builder has no supported extensions).