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

Interface IParaViewProxyBuilder

All Known Implementing Classes:

AbstractParaViewProxyBuilder, ExodusProxyBuilder, SiloProxyBuilder, VtkProxyBuilder

public interface IParaViewProxyBuilder

This interface provides a builder from which IParaViewProxy instances can be created for a set of supported extensions.

Instances of this class should register with the IParaViewProxyFactory via OSGi.

Author:

Jordan Deyton

Method Summary

Modifier and Type	Method and Description
IParaViewProxy	createProxy(java.net.URI uri) Creates an IParaViewProxy for the specified file based on its extension.
java.util.Set<java.lang.String>	getExtensions() Gets the set of supported extensions.
java.lang.String	getName() Gets a nice name for the builder.

Method Detail

createProxy

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

Creates an IParaViewProxy for the specified file based on its extension.

Parameters:

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

Returns:

A proxy for the file, or null if the specified file is null or a proxy cannot be created.

Throws:

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

java.lang.IllegalArgumentException - If the file's extension is not supported by this proxy.

getExtensions

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

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

Returns:

The set of supported extensions for this builder. This should never be null, and should not change throughout the builder's lifecycle.

getName

java.lang.String getName()

Gets a nice name for the builder. This is primarily intended for use when exposing the builder to the developer.

Returns:

A name for the builder. Should not be null.