com.google.api.services.sheets.v4.model

Class HistogramRule

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.sheets.v4.model.HistogramRule

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class HistogramRule
extends com.google.api.client.json.GenericJson

Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
HistogramRule()

Method Summary

Modifier and Type	Method and Description
HistogramRule	clone()
java.lang.Double	getEnd() The maximum value at which items are placed into buckets of constant size.
java.lang.Double	getInterval() The size of the buckets that are created.
java.lang.Double	getStart() The minimum value at which items are placed into buckets of constant size.
HistogramRule	set(java.lang.String fieldName, java.lang.Object value)
HistogramRule	setEnd(java.lang.Double end) The maximum value at which items are placed into buckets of constant size.
HistogramRule	setInterval(java.lang.Double interval) The size of the buckets that are created.
HistogramRule	setStart(java.lang.Double start) The minimum value at which items are placed into buckets of constant size.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

HistogramRule

public HistogramRule()

Method Detail

getEnd

public java.lang.Double getEnd()

The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional.

Returns:

value or null for none

setEnd

public HistogramRule setEnd(java.lang.Double end)

The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional.

Parameters:

end - end or null for none

getInterval

public java.lang.Double getInterval()

The size of the buckets that are created. Must be positive.

Returns:

value or null for none

setInterval

public HistogramRule setInterval(java.lang.Double interval)

The size of the buckets that are created. Must be positive.

Parameters:

interval - interval or null for none

getStart

public java.lang.Double getStart()

The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional.

Returns:

value or null for none

setStart

public HistogramRule setStart(java.lang.Double start)

The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional.

Parameters:

start - start or null for none

set

public HistogramRule set(java.lang.String fieldName,
                         java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public HistogramRule clone()

Overrides:

clone in class com.google.api.client.json.GenericJson