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

Class ParaViewProxyFactory

java.lang.Object

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

All Implemented Interfaces:

IParaViewProxyFactory

public class ParaViewProxyFactory
extends java.lang.Object
implements IParaViewProxyFactory

This class provides the standard implementation of the IParaViewProxyFactory.

This implementation provides an additional feature: If multiple builders support the same extensions, then for each shared extension, the most recently registered builder will be returned in #getProxyBuilder(URI) . Furthermore, when that builder is unregistered, its supported extensions will fall back to the previously registered builder for that extension.

Author:

Jordan Deyton

Constructor Summary

Constructors

Constructor and Description
ParaViewProxyFactory() The default constructor.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParaViewProxyFactory

public ParaViewProxyFactory()

The default constructor.

Note: This class should be instantiated by OSGi!

Method Detail

createProxy

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

Description copied from interface: IParaViewProxyFactory

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

Specified by:

createProxy in interface IParaViewProxyFactory

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

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

Description copied from interface: IParaViewProxyFactory

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.

Specified by:

getExtensions in interface IParaViewProxyFactory

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

public boolean registerProxyBuilder(IParaViewProxyBuilder builder)

Description copied from interface: IParaViewProxyFactory

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

This method will usually be called by OSGi.

Specified by:

registerProxyBuilder in interface IParaViewProxyFactory

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

public boolean unregisterProxyBuilder(IParaViewProxyBuilder builder)

Description copied from interface: IParaViewProxyFactory

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.

Specified by:

unregisterProxyBuilder in interface IParaViewProxyFactory

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).