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

Class HistogramRule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class HistogramRule
extends 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 will be placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start will be placed in one group, and all values above HistogramRule.end will be 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: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

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

GenericData.Flags

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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
HistogramRule()

Method Summary

Methods

Modifier and Type	Method and Description
HistogramRule	clone()
Double	getEnd() Optional.
Double	getInterval() Required.
Double	getStart() Optional.
HistogramRule	set(String fieldName, Object value)
HistogramRule	setEnd(Double end) Optional.
HistogramRule	setInterval(Double interval) Required.
HistogramRule	setStart(Double start) Optional.

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

Constructor Detail

HistogramRule

public HistogramRule()

Method Detail

getEnd

public Double getEnd()

Optional. The maximum value at which items will be placed into buckets of constant size. Values above end will be lumped into a single bucket.

Returns:

value or null for none

setEnd

public HistogramRule setEnd(Double end)

Optional. The maximum value at which items will be placed into buckets of constant size. Values above end will be lumped into a single bucket.

Parameters:

end - end or null for none

getInterval

public Double getInterval()

Required. The size of the buckets that will be created. Must be positive.

Returns:

value or null for none

setInterval

public HistogramRule setInterval(Double interval)

Required. The size of the buckets that will be created. Must be positive.

Parameters:

interval - interval or null for none

getStart

public Double getStart()

Optional. The minimum value at which items will be placed into buckets of constant size. Values below start will be lumped into a single bucket.

Returns:

value or null for none

setStart

public HistogramRule setStart(Double start)

Optional. The minimum value at which items will be placed into buckets of constant size. Values below start will be lumped into a single bucket.

Parameters:

start - start or null for none

set

public HistogramRule set(String fieldName,
                Object value)

Overrides:

set in class GenericJson

clone

public HistogramRule clone()

Overrides:

clone in class GenericJson