Class ScatterPlotCategoricallyAggregatedFieldWells

    • Method Detail

      • hasXAxis

        public final boolean hasXAxis()
        For responses, this returns true if the service returned a value for the XAxis property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • xAxis

        public final List<MeasureField> xAxis()

        The x-axis field well of a scatter plot.

        The x-axis is aggregated by category.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasXAxis() method.

        Returns:
        The x-axis field well of a scatter plot.

        The x-axis is aggregated by category.

      • hasYAxis

        public final boolean hasYAxis()
        For responses, this returns true if the service returned a value for the YAxis property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • yAxis

        public final List<MeasureField> yAxis()

        The y-axis field well of a scatter plot.

        The y-axis is aggregated by category.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasYAxis() method.

        Returns:
        The y-axis field well of a scatter plot.

        The y-axis is aggregated by category.

      • hasCategory

        public final boolean hasCategory()
        For responses, this returns true if the service returned a value for the Category property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • category

        public final List<DimensionField> category()

        The category field well of a scatter plot.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCategory() method.

        Returns:
        The category field well of a scatter plot.
      • hasSize

        public final boolean hasSize()
        For responses, this returns true if the service returned a value for the Size property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • size

        public final List<MeasureField> size()

        The size field well of a scatter plot.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSize() method.

        Returns:
        The size field well of a scatter plot.
      • hasLabel

        public final boolean hasLabel()
        For responses, this returns true if the service returned a value for the Label property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • label

        public final List<DimensionField> label()

        The label field well of a scatter plot.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLabel() method.

        Returns:
        The label field well of a scatter plot.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)