public interface IParaViewProxy
Furthermore, a proxy provides an interface to ParaViewPlots for access to the contents of the file.
Under the hood, a proxy manages three separate "proxies" from the ParaView web client, each with its own ID:
file
- includes metadata about the file,
including the data sets that are available and the available timestepsview
- includes properties that can be used
to tweak how the visualized data is diplayedrepresentation
- includes metadata
about how the visualization representation is handled, including what dataset
is used to color itModifier and Type | Method and Description |
---|---|
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 timestep)
Sets the timestep for the loaded proxy.
|
java.util.Set<java.lang.String> getFeatureCategories()
java.util.Set<java.lang.String> getFeatures(java.lang.String category)
category
- The category whose features will be returned. This should be a
value retrieved from getFeatureCategories()
.null
if the category name
is invalid.int getFileId()
-1
if the proxy was not
opened.java.util.Map<java.lang.String,java.lang.String> getProperties()
java.lang.String getProperty(java.lang.String name)
name
- The name of the property to retrieve.null
if the
property name is invalid.java.util.Set<java.lang.String> getPropertyAllowedValues(java.lang.String name)
name
- The property whose allowed values will be returned.null
if the property name is invalid.int getRepresentationId()
-1
if the
proxy was not opened.java.util.List<java.lang.Double> getTimesteps()
null
.java.net.URI getURI()
int getViewId()
-1
if the proxy was not
opened.java.util.concurrent.Future<java.lang.Boolean> open(IVizConnection<IParaViewWebClient> connection)
connection
- The connection to use when opening the URI. Should not be
null
.java.util.concurrent.Future<java.lang.Boolean> setFeature(java.lang.String category, java.lang.String feature)
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.java.util.concurrent.Future<java.lang.Integer> setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
If a given property or value in the provided map is invalid, then the property is skipped.
properties
- The new properties to set.java.util.concurrent.Future<java.lang.Boolean> setProperty(java.lang.String name, java.lang.String value)
name
- The property to updated. Allowed values can be retrieved via
getProperties()
.value
- The new value of the property. Allowed values can be retrieved
via getPropertyAllowedValues(String)
.java.util.concurrent.Future<java.lang.Boolean> setTimestep(int timestep)
timestep
- The new timestep index.