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

Class AbstractParaViewProxy

java.lang.Object

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

All Implemented Interfaces:

IParaViewProxy

Direct Known Subclasses:

ExodusProxy, FakeParaViewProxy, SiloProxy, VtkProxy

public class AbstractParaViewProxy
extends java.lang.Object
implements IParaViewProxy

This class provides a base implementation for IParaViewProxy and handles updating the ParaView web client when the proxy's information changes.

Author:

Jordan Deyton

Constructor Summary

Constructors

Constructor and Description
AbstractParaViewProxy(java.net.URI uri) The default constructor.

Method Summary

Modifier and Type	Method and Description
IVizConnection<IParaViewWebClient>	getConnection() Gets the current connection associated with this proxy.
java.util.Set<java.lang.String>	getFeatureCategories() Gets the categories of "features" in the file that can be rendered.
java.util.Set<java.lang.String>	getFeatures(java.lang.String category) Gets the file's "features" that can be rendered for the specified category.
int	getFileId() Gets the ID of the underlying "file" object.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Gets the current properties for the proxy.
java.lang.String	getProperty(java.lang.String name) Gets the current value for the proxy's specified property.
java.util.Set<java.lang.String>	getPropertyAllowedValues(java.lang.String name) Gets the set of allowed values for the specified property.
int	getRepresentationId() Gets the ID of the underlying "representation" object.
java.util.List<java.lang.Double>	getTimesteps() Gets a list of timesteps for the loaded proxy.
java.net.URI	getURI() Gets the current URI associated with the proxy.
int	getViewId() Gets the ID of the underlying "view" object.
java.util.concurrent.Future<java.lang.Boolean>	open(IVizConnection<IParaViewWebClient> connection) Opens the designated URI, if possible, using the specified ParaView connection.
java.util.concurrent.Future<java.lang.Boolean>	setFeature(java.lang.String category, java.lang.String feature) Sets the current feature that is rendered via ParaView.
java.util.concurrent.Future<java.lang.Integer>	setProperties(java.util.Map<java.lang.String,java.lang.String> properties) Updates the proxy's current properties to include all properties listed in the specified map.
java.util.concurrent.Future<java.lang.Boolean>	setProperty(java.lang.String name, java.lang.String value) Sets the specified property to the new value.
java.util.concurrent.Future<java.lang.Boolean>	setTimestep(int step) Sets the timestep for the loaded proxy.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractParaViewProxy

public AbstractParaViewProxy(java.net.URI uri)
                      throws java.lang.NullPointerException

The default constructor.

Parameters:

uri - The URI for the ParaView-supported file.

Throws:

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

Method Detail

getConnection

public IVizConnection<IParaViewWebClient> getConnection()

Gets the current connection associated with this proxy.

Returns:

The proxy's current connection, or null if it has not been set.

getFeatureCategories

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

Description copied from interface: IParaViewProxy

Gets the categories of "features" in the file that can be rendered. This may include categories such as "point arrays" or "cell arrays".

Specified by:

getFeatureCategories in interface IParaViewProxy

Returns:

A set of categories of "features" in the file.

getFeatures

public java.util.Set<java.lang.String> getFeatures(java.lang.String category)

Description copied from interface: IParaViewProxy

Gets the file's "features" that can be rendered for the specified category.

Specified by:

getFeatures in interface IParaViewProxy

Parameters:

category - The category whose features will be returned. This should be a value retrieved from IParaViewProxy.getFeatureCategories().

Returns:

A set of features that can be rendered. This set may be unique to the specified category. Returns null if the category name is invalid.

getFileId

public int getFileId()

Description copied from interface: IParaViewProxy

Gets the ID of the underlying "file" object.

Specified by:

getFileId in interface IParaViewProxy

Returns:

The ID of the underlying file, or -1 if the proxy was not opened.

getProperties

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

Description copied from interface: IParaViewProxy

Gets the current properties for the proxy.

Specified by:

getProperties in interface IParaViewProxy

Returns:

A map of the current properties for the proxy. The keys are property names, while the values are their current values.

getProperty

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

Description copied from interface: IParaViewProxy

Gets the current value for the proxy's specified property.

Specified by:

getProperty in interface IParaViewProxy

Parameters:

name - The name of the property to retrieve.

Returns:

The current value of the property, or null if the property name is invalid.

getPropertyAllowedValues

public java.util.Set<java.lang.String> getPropertyAllowedValues(java.lang.String name)

Description copied from interface: IParaViewProxy

Gets the set of allowed values for the specified property.

Specified by:

getPropertyAllowedValues in interface IParaViewProxy

Parameters:

name - The property whose allowed values will be returned.

Returns:

A set containing all allowed values for the specified property, or null if the property name is invalid.

getRepresentationId

public int getRepresentationId()

Description copied from interface: IParaViewProxy

Gets the ID of the underlying "representation" object.

Specified by:

getRepresentationId in interface IParaViewProxy

Returns:

The ID of the underlying representation, or -1 if the proxy was not opened.

getTimesteps

public java.util.List<java.lang.Double> getTimesteps()

Description copied from interface: IParaViewProxy

Gets a list of timesteps for the loaded proxy.

Specified by:

getTimesteps in interface IParaViewProxy

Returns:

A list containing the allowed timesteps for the proxy. This list may be empty, but should not be null.

getURI

public java.net.URI getURI()

Description copied from interface: IParaViewProxy

Gets the current URI associated with the proxy.

Specified by:

getURI in interface IParaViewProxy

Returns:

The URI pointing to the proxy's file.

getViewId

public int getViewId()

Description copied from interface: IParaViewProxy

Gets the ID of the underlying "view" object.

Specified by:

getViewId in interface IParaViewProxy

Returns:

The ID of the underlying view, or -1 if the proxy was not opened.

open

public java.util.concurrent.Future<java.lang.Boolean> open(IVizConnection<IParaViewWebClient> connection)

Description copied from interface: IParaViewProxy

Opens the designated URI, if possible, using the specified ParaView connection.

Specified by:

open in interface IParaViewProxy

Parameters:

connection - The connection to use when opening the URI. Should not be null.

Returns:

True if the proxy could be opened using the connection (also when it is already open), false otherwise.

setFeature

public java.util.concurrent.Future<java.lang.Boolean> setFeature(java.lang.String category,
                                                                 java.lang.String feature)

Description copied from interface: IParaViewProxy

Sets the current feature that is rendered via ParaView.

Specified by:

setFeature in interface IParaViewProxy

Parameters:

category - The category for the feature. This should be one of the keys in the map returned by #getFeatures().

feature - The feature or "type" to be rendered. This should be in the set (from the feature map) associated with the category key.

Returns:

True if the feature was changed, false otherwise.

setProperties

public java.util.concurrent.Future<java.lang.Integer> setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Description copied from interface: IParaViewProxy

Updates the proxy's current properties to include all properties listed in the specified map. This can be used for a bulk update of properties that triggers only a single refresh of the rendered view.

If a given property or value in the provided map is invalid, then the property is skipped.

Specified by:

setProperties in interface IParaViewProxy

Parameters:

properties - The new properties to set.

Returns:

The number of properties that were updated. Properties whose values were already set do not count.

setProperty

public java.util.concurrent.Future<java.lang.Boolean> setProperty(java.lang.String name,
                                                                  java.lang.String value)

Description copied from interface: IParaViewProxy

Sets the specified property to the new value.

Specified by:

setProperty in interface IParaViewProxy

Parameters:

name - The property to updated. Allowed values can be retrieved via IParaViewProxy.getProperties().

value - The new value of the property. Allowed values can be retrieved via IParaViewProxy.getPropertyAllowedValues(String).

Returns:

True if the property was changed, false otherwise.

setTimestep

public java.util.concurrent.Future<java.lang.Boolean> setTimestep(int step)

Description copied from interface: IParaViewProxy

Sets the timestep for the loaded proxy.

Specified by:

setTimestep in interface IParaViewProxy

Parameters:

step - The new timestep index.

Returns:

True if the timestep changed, false otherwise.