Class BoundaryRangeValues<T>

  • Type Parameters:
    T - the generic type for this BoundaryRangeValues.

    public final class BoundaryRangeValues<T>
    extends Object
    This class defines a data object representing the range values associated with a particular domain value, called a boundary value. The domain value is not stored here, since objects of this class are intended to be used as the values in a map where the domain value is the key. Three values must be specified for each boundary value. The lesserValue field is used for interpolation upon smaller domain values; the greaterValue field is used for interpolation upon larger domain values; and the equalValue field is used when the domain value is exactly equal to the associated boundary domain value. This distinction is needed to support different ranges of interpolation above and below the same domain value, plus allow a distinctly different value for exact matches.

    Module: vizmap-api

    To use this in your app, include the following dependency in your POM:

    <dependency>
        <groupId>org.cytoscape</groupId>
        <artifactId>vizmap-api</artifactId>
    </dependency>

    Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
    • Field Detail

      • lesserValue

        public final T lesserValue
        Will be used for interpolation upon smaller domain values
      • equalValue

        public final T equalValue
        Will be used when the domain value is exactly equal to the associated boundary domain value
      • greaterValue

        public final T greaterValue
        Will be used for interpolation upon larger domain values
    • Constructor Detail

      • BoundaryRangeValues

        public BoundaryRangeValues​(T lesser,
                                   T equal,
                                   T greater)
        Creates a new BoundaryRangeValues object.
        Parameters:
        lesser - Object used for values less than this point.
        equal - Object used for value equal to this point.
        greater - Object used for values greater than this point.
      • BoundaryRangeValues

        public BoundaryRangeValues​(BoundaryRangeValues<T> original)
        Creates a new BoundaryRangeValues object. This is a copy constructor.
        Parameters:
        original - original value.