org.eclipse.eavp.viz.service.connections

Interface IVizConnection<T>

Type Parameters:

T - The type of the underlying connection widget.

All Known Implementing Classes:

FakeVizConnection, ParaViewConnection, VisItConnection, VizConnection

public interface IVizConnection<T>

This is an interface for connections intended solely for consumption by viz services or their plots. It provides access to a connection's current state as well as access to the underlying widget for service- or plot-specific functionality.

Instead of directly implementing this interface, classes should inherit from VizConnection.

Instances of this class will usually be created by and acquired from a VizConnectionManager.

Author:

Jordan Deyton

Method Summary

Modifier and Type	Method and Description
boolean	addListener(IVizConnectionListener<T> listener) Adds a listener for state changes to this connection.
java.lang.String	getDescription() Gets a description of the connection.
java.lang.String	getHost() Gets the current host associated with the connection.
java.lang.String	getName() Gets the name of the connection.
java.lang.String	getPath() Gets the installation path to the executable required to run the associated connection widget.
int	getPort() Gets the port associated with the connection.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Gets the current properties for this connection.
java.lang.String	getProperty(java.lang.String name) Gets the value of the property with the specified name.
ConnectionState	getState() Gets the current state of the connection.
java.lang.String	getStatusMessage() Gets a descriptive message for the current state of the connection.
T	getWidget() Gets the underlying connection widget managed by this viz connection instance.
boolean	removeListener(IVizConnectionListener<T> listener) Removes a listener from state change notifications.

Method Detail

addListener

boolean addListener(IVizConnectionListener<T> listener)

Adds a listener for state changes to this connection. A listener can only be registered once, and will be notified on a separate thread when the connection state changes.

Parameters:

listener - The listener to add. If null, no listener will be added.

Returns:

True if the specified listener was added, false otherwise.

getDescription

java.lang.String getDescription()

Gets a description of the connection. This should be a string that can be displayed to the user.

Returns:

A description of the connection. Should not be null, but may be an empty string.

getHost

java.lang.String getHost()

Gets the current host associated with the connection. For local connections, this will be "localhost".

Returns:

The current host. This value should never be null.

getName

java.lang.String getName()

Gets the name of the connection. This name should be unique within its associated VizConnectionManager.

Returns:

The (unique) name of the connection.

getPath

java.lang.String getPath()

Gets the installation path to the executable required to run the associated connection widget. This should be a full path formatted to the host machine's operating system.

Returns:

The installation path to the visualization engine on the host machine.

getPort

int getPort()

Gets the port associated with the connection. This is the port at which the associated connection widget hosts the viz rendering service.

Returns:

The connection's port.

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Gets the current properties for this connection. This should never be null and should always contain the name, description, host, port, and path, as well as any other properties required by the implementing class.

Returns:

The connection's properties.

getProperty

java.lang.String getProperty(java.lang.String name)

Gets the value of the property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

The current value of the property with the specified name, or null if it has not been set.

getState

ConnectionState getState()

Gets the current state of the connection.

This may change at any moment. If code needs to listen for the current state, then a listener should be registered via addListener(IVizConnectionListener).

Returns:

The current connection state.

getStatusMessage

java.lang.String getStatusMessage()

Gets a descriptive message for the current state of the connection.

This may change at any moment. If code needs to listen for the current state, then a listener should be registered via addListener(IVizConnectionListener).

Returns:

The current status message.

getWidget

T getWidget()

Gets the underlying connection widget managed by this viz connection instance.

Returns:

The current connection widget. May be null if the connection is currently disconnected or failed.

removeListener

boolean removeListener(IVizConnectionListener<T> listener)

Removes a listener from state change notifications.

Parameters:

listener - The listener to remove.

Returns:

True if the listener was removed, false otherwise (including if the listener was not already listening).