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

Class ProxyFeature

java.lang.Object

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

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

Direct Known Subclasses:

FakeProxyFeature

public abstract class ProxyFeature
extends ProxyProperty

This class provides a proxy property for "features", or properties that correspond to the names of data that can be rendered with the ParaView web client.

Author:

Jordan Deyton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxyFeature.ColorByLocation An enumeration for allowed values for the "location" of the visualization data for this feature.
static class	ProxyFeature.ColorByMode An enumeration for allowed values for the mode to use when coloring the visualization with a feature.

Nested classes/interfaces inherited from class org.eclipse.eavp.viz.service.paraview.proxy.ProxyProperty

ProxyProperty.PropertyType

Field Summary

Fields inherited from class org.eclipse.eavp.viz.service.paraview.proxy.ProxyProperty

index, name

Constructor Summary

Constructors

Constructor and Description
ProxyFeature(java.lang.String name, int index) The default constructor.
ProxyFeature(java.lang.String name, int index, ProxyFeature.ColorByMode mode, ProxyFeature.ColorByLocation location) The most commonly-used constructor.
ProxyFeature(java.lang.String name, int index, ProxyProperty.PropertyType type, ProxyFeature.ColorByMode mode, ProxyFeature.ColorByLocation location) The full constructor.

Method Summary

Methods inherited from class org.eclipse.eavp.viz.service.paraview.proxy.ProxyProperty

getAllowedValues, getValue, getValues, setConnection, setValue, setValues, valueAllowed

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyFeature

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

The default constructor. A feature constructed with this method cannot be visualized with colors.

Parameters:

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

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

ProxyFeature

public ProxyFeature(java.lang.String name,
                    int index,
                    ProxyFeature.ColorByMode mode,
                    ProxyFeature.ColorByLocation location)

The most commonly-used constructor. If either the mode or the location are null , the feature cannot be visualized with colors.

Parameters:

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

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

mode - The mode to use when coloring the visualization with this feature.

location - The "location" of the visualization data for this feature.

ProxyFeature

public ProxyFeature(java.lang.String name,
                    int index,
                    ProxyProperty.PropertyType type,
                    ProxyFeature.ColorByMode mode,
                    ProxyFeature.ColorByLocation location)

The full constructor. If the property type is null, it defauls to discrete with multi-select enabled. If either the mode or the location are null , the feature cannot be visualized with colors.

Parameters:

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

index - The index of the feature 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.

mode - The mode to use when coloring the visualization with this feature.

location - The "location" of the visualization data for this feature.