org.eclipse.eavp.viz.service.connections

Class VizConnectionManager<T>

java.lang.Object

org.eclipse.eavp.viz.service.connections.VizConnectionManager<T>

Type Parameters:

T - The type of the underlying connection widget.

All Implemented Interfaces:

IVizConnectionManager<T>

Direct Known Subclasses:

ParaViewConnectionManager, VisItConnectionManager

public abstract class VizConnectionManager<T>
extends java.lang.Object
implements IVizConnectionManager<T>

This class provides a basic implementation of IVizConnectionManager, which is responsible for synchronizing IVizConnections with Eclipse preferences.

Author:

Jordan Deyton

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.service.connections.IVizConnectionManager

DEFAULT_CONNECTION_PREFERENCE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
VizConnectionManager() The default constructor.

Method Summary

Modifier and Type	Method and Description
IVizConnection<T>	getConnection(java.lang.String name) Gets the viz connection with the specified name.
java.util.Set<java.lang.String>	getConnections() Gets the names of all available connections.
java.util.Set<java.lang.String>	getConnectionsForHost(java.lang.String host) Gets all connections available for the specified host.
java.util.ArrayList<java.util.concurrent.Future<ConnectionState>>	setPreferenceStore(CustomScopedPreferenceStore store, java.lang.String preferenceNodeId) Sets the preference store used by the manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

VizConnectionManager

public VizConnectionManager()

The default constructor.

Method Detail

getConnection

public IVizConnection<T> getConnection(java.lang.String name)

Description copied from interface: IVizConnectionManager

Gets the viz connection with the specified name. Names should be retrieved from either IVizConnectionManager.getConnections() or IVizConnectionManager.getConnectionsForHost(String).

Specified by:

getConnection in interface IVizConnectionManager<T>

Parameters:

name - The name of the connection to acquire.

Returns:

The associated viz connection, or null if there is no connection for the specified name.

getConnections

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

Description copied from interface: IVizConnectionManager

Gets the names of all available connections.

Specified by:

getConnections in interface IVizConnectionManager<T>

Returns:

A lexicographically ordered set of available connection names.

getConnectionsForHost

public java.util.Set<java.lang.String> getConnectionsForHost(java.lang.String host)
                                                      throws java.lang.NullPointerException

Description copied from interface: IVizConnectionManager

Gets all connections available for the specified host.

Specified by:

getConnectionsForHost in interface IVizConnectionManager<T>

Parameters:

host - The host machine. Must not be null, but may be "localhost" or otherwise a resolvable hostname.

Returns:

A lexicographically ordered set of connection names associated with the specified host. This set may be empty if there are no connections to the host.

Throws:

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

setPreferenceStore

public java.util.ArrayList<java.util.concurrent.Future<ConnectionState>> setPreferenceStore(CustomScopedPreferenceStore store,
                                                                                            java.lang.String preferenceNodeId)
                                                                                     throws java.lang.NullPointerException

Description copied from interface: IVizConnectionManager

Sets the preference store used by the manager. This will first cause any existing connections to be terminated. If any connections can be loaded from the store, the manager will attempt to connect to them.

Specified by:

setPreferenceStore in interface IVizConnectionManager<T>

Parameters:

store - The new store. Should not be null.

preferenceNodeId - The ID of the preference node. Connection preferences will be found under this node. Should not be null.

Returns:

A list of Future states for each of the connections added to the preference store.

Throws:

java.lang.NullPointerException - If the preference node ID is null and the store is not.