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

Class ProxyProperty

java.lang.Object

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

Direct Known Subclasses:

ProxyFeature

public abstract class ProxyProperty
extends java.lang.Object

This class provides basic functionality for accessing and modifying properties for a ParaView proxy (which is returned as a JsonObject when calling "pv.proxy.manager.get").

Before a property can be used, its AbstractParaViewProxy must be set by calling #setProxy(AbstractParaViewProxy).

This class helps deal with the structures in the ParaView web client's proxies. In general, a file, view, or representation proxy adheres to the format below:

1. data - JsonArray - Contains some useful metadata, including:
   • "time" - JsonArray of doubles - The timesteps in the file.
2. ui - JsonArray - Contains metadata about properties, which can be used to construct a UI for changing said properties. For example, each element may include:
   • "name" - The name of the property.
   • "widget" - One of { list-1, list-n, checkbox, textfield }.
   • "type" - The primitive data type for the values (e.g., "str" or "float").
   • "values" - If the "widget" is list-1 or list-n, this is an array of the allowed values.
   • (and more...)
3. properties - JsonArray - Contains the current value(s) for the properties. This is indexed exactly the same as the "ui" array. Each element may include the following properties:
   • "name" - The name of the property, used for lookup. This is usually different from the "name" in the "ui" array.
   • "value" - If the corresponding "widget" is list-n, this is an array of the selected values. Otherwise, it is the current value.
   • (and more...)

Author:

Jordan Deyton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxyProperty.PropertyType This enumeration is used to determine how certain properties should be treated.

Field Summary

Fields

Modifier and Type	Field and Description
int	index The index of the property in its parent proxy's "ui" and "properties" JsonArrays.
java.lang.String	name The name of the property.

Constructor Summary

Constructors

Constructor and Description
ProxyProperty(java.lang.String name, int index) The default constructor.
ProxyProperty(java.lang.String name, int index, ProxyProperty.PropertyType type) The full constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAllowedValues() Gets the allowed values for the property.
java.lang.String	getValue() Gets the current value for the property.
java.util.List<java.lang.String>	getValues() Gets the currently selected values for the property.
boolean	setConnection(IVizConnection<IParaViewWebClient> connection) Sets the connection used for this property.
boolean	setValue(java.lang.String value) Sets the value to the specified value.
boolean	setValues(java.util.List<java.lang.String> values) Sets the selected values for the property.
boolean	valueAllowed(java.lang.String value) Determines whether the specified value is allowed.

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

The name of the property. This corresponds to the "name" value in the corresponding array element in the "ui" array.

index

public final int index

The index of the property in its parent proxy's "ui" and "properties" JsonArrays.

Constructor Detail

ProxyProperty

public ProxyProperty(java.lang.String name,
                     int index)

The default constructor.

Parameters:

name - The name of the property. This corresponds to the "name" value in the corresponding array element in the "ui" array.

index - The index of the property in its parent proxy's "ui" and "properties" JsonArrays.

ProxyProperty

public ProxyProperty(java.lang.String name,
                     int index,
                     ProxyProperty.PropertyType type)

The full constructor.

Parameters:

name - The name of the property. This corresponds to the "name" value in the corresponding array element in the "ui" array.

index - The index of the property in its parent proxy's "ui" and "properties" JsonArrays.

type - The type of property. This dictates the format of the "values" and "value" JsonElements in its "ui" and "properties" entries, respectively.

Method Detail

getAllowedValues

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

Gets the allowed values for the property.

Returns:

A set containing all allowed values for the property.

getValue

public java.lang.String getValue()

Gets the current value for the property.

Returns:

The current value of the property, or null if the property is unset or has the type ProxyProperty.PropertyType.DISCRETE_MULTI.

getValues

public java.util.List<java.lang.String> getValues()

Gets the currently selected values for the property.

Returns:

The currently selected values for the property if the property has the type ProxyProperty.PropertyType.DISCRETE_MULTI, or an empty collection otherwise.

setConnection

public boolean setConnection(IVizConnection<IParaViewWebClient> connection)

Sets the connection used for this property. This synchronizes this data structure with the "ui" and "properties" arrays for the remote proxy object with the ID specified by getProxyId().

Parameters:

connection - The new connection. If null or not connected, the property's data will be cleared.

Returns:

True if the connection changed, false otherwise.

setValue

public boolean setValue(java.lang.String value)

Sets the value to the specified value.

If the property type is ProxyProperty.PropertyType.DISCRETE_MULTI, then the selected values will be changed to the provided value.

Parameters:

value - The new value of the property.

Returns:

True if the value of the property changed.

setValues

public boolean setValues(java.util.List<java.lang.String> values)
                  throws java.lang.NullPointerException,
                         java.lang.UnsupportedOperationException

Sets the selected values for the property. Duplicates and bad values are ignored.

Note: This method only applies to properties of the type ProxyProperty.PropertyType.DISCRETE_MULTI.

Parameters:

values - The new selected values. May be an empty list.

Returns:

True if the property changed, false otherwise.

Throws:

java.lang.NullPointerException

java.lang.UnsupportedOperationException

valueAllowed

public boolean valueAllowed(java.lang.String value)

Determines whether the specified value is allowed.

Parameters:

value - The value to test.

Returns:

True if the value is valid, false otherwise.