org.eclipse.eavp.viz.service.connections.preferences

Class ConnectionTable

java.lang.Object

org.eclipse.eavp.viz.datastructures.VizObject.VizObject

org.eclipse.eavp.viz.datastructures.VizTableComponent

org.eclipse.eavp.viz.service.connections.preferences.ConnectionTable

All Implemented Interfaces:

IVizObject, IVizUpdateable

public class ConnectionTable
extends VizTableComponent

This class manages a list of uniquely-keyed connections within an ICE TableComponent.

Each connection is defined by the following parameters (although it must be noted that the only required unique value is the name/key/ID):

1. Name - A unique ID or key for the connection. This should be a user-friendly value.
2. Host - The FQDN or IP address of the remote host. For local launches, this should be "localhost".
3. Port - The port on which the host serves the connection. The default is 9600.
4. Host OS - The operating system on the host.
5. Path - The path to the VisIt binaries on the host.
6. Username - The username to use when connecting to a remote host.
7. Password - The password to use when connecting to a remote host.
8. Proxy - The FQDN or IP address of a proxy. If specified, the connection will route through the proxy to the host.
9. Proxy Port - The port to which the client must connect to use the proxy.

Author:

Jordan Deyton

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

iComponentListener

Constructor Summary

Constructors

Constructor and Description
ConnectionTable() The default constructor.

Method Summary

Modifier and Type	Method and Description
int	addRow() This operation adds a row to the Table and returns the index of that row.
boolean	deleteRow(int index) This operation will delete the row in the table with the specified index.
java.util.List<VizEntry>	getConnection(java.lang.String name) Gets the row from the underlying TableComponent corresponding to the name of the connection.
java.util.Set<java.lang.String>	getConnectionNames() Gets the set of connection names or keys.
void	setRowTemplate(java.util.ArrayList<VizEntry> template) Does nothing.

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizTableComponent

clone, copy, equals, getColumnNames, getRow, getRowIds, getRowTemplate, getSelectedRows, hashCode, numberOfColumns, numberOfRows, setSelectedRows

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizObject.VizObject

copy, getDescription, getId, getName, register, setDescription, setId, setName, unregister, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionTable

public ConnectionTable()

The default constructor.

Method Detail

addRow

public int addRow()

Description copied from class: VizTableComponent

This operation adds a row to the Table and returns the index of that row. The new row may be retrieved and its Entries may be edited by calling getRow() using the returned index. When a new row is added, the elements of that row are configured from the row template using its default values. If the Row Template has not yet been set for the TableComponent, this operation cannot add a row and it returns -1.

Overrides:

addRow in class VizTableComponent

Returns:

The index of the new row in the table.

deleteRow

public boolean deleteRow(int index)

Description copied from class: VizTableComponent

This operation will delete the row in the table with the specified index. It will return true if it is success or false otherwise (like if it can not find a row with that index).

Overrides:

deleteRow in class VizTableComponent

Parameters:

index -

The index of the row that should be deleted.

Returns:

True if the row was deleted and false if some problem was encountered, like an incorrect row id.

getConnection

public java.util.List<VizEntry> getConnection(java.lang.String name)

Gets the row from the underlying TableComponent corresponding to the name of the connection.

Parameters:

name - The name of the connection.

Returns:

A row from the TableComponent, or null if the name is invalid.

getConnectionNames

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

Gets the set of connection names or keys.

Returns:

The connection names.

setRowTemplate

public void setRowTemplate(java.util.ArrayList<VizEntry> template)

Does nothing. The row template cannot be changed for this class.

Overrides:

setRowTemplate in class VizTableComponent

Parameters:

template -

The set of Entries that represent the canonical row of this table.