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

Class PivotGroupSortValueBucket

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.PivotGroupSortValueBucket

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PivotGroupSortValueBucket
extends GenericJson

Information about which values in a pivot group should be used for sorting.

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
PivotGroupSortValueBucket()

Method Summary

Methods

Modifier and Type	Method and Description
PivotGroupSortValueBucket	clone()
List<ExtendedValue>	getBuckets() Determines the bucket from which values are chosen to sort.
Integer	getValuesIndex() The offset in the PivotTable.values list which the values in this grouping should be sorted by.
PivotGroupSortValueBucket	set(String fieldName, Object value)
PivotGroupSortValueBucket	setBuckets(List<ExtendedValue> buckets) Determines the bucket from which values are chosen to sort.
PivotGroupSortValueBucket	setValuesIndex(Integer valuesIndex) The offset in the PivotTable.values list which the values in this grouping should be sorted by.

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

PivotGroupSortValueBucket

public PivotGroupSortValueBucket()

Method Detail

getBuckets

public List<ExtendedValue> getBuckets()

Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second value corresponds to a value in the second column group. If no values are listed, this would indicate that the row should be sorted according to the "Grand Total" over the column groups. If a single value is listed, this would correspond to using the "Total" of that bucket.

Returns:

value or null for none

setBuckets

public PivotGroupSortValueBucket setBuckets(List<ExtendedValue> buckets)

Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second value corresponds to a value in the second column group. If no values are listed, this would indicate that the row should be sorted according to the "Grand Total" over the column groups. If a single value is listed, this would correspond to using the "Total" of that bucket.

Parameters:

buckets - buckets or null for none

getValuesIndex

public Integer getValuesIndex()

The offset in the PivotTable.values list which the values in this grouping should be sorted by.

Returns:

value or null for none

setValuesIndex

public PivotGroupSortValueBucket setValuesIndex(Integer valuesIndex)

The offset in the PivotTable.values list which the values in this grouping should be sorted by.

Parameters:

valuesIndex - valuesIndex or null for none

set

public PivotGroupSortValueBucket set(String fieldName,
                            Object value)

Overrides:

set in class GenericJson

clone

public PivotGroupSortValueBucket clone()

Overrides:

clone in class GenericJson