com.google.common.collect

Class StandardTable<R,C,V>

java.lang.Object

com.google.common.collect.AbstractTable<R,C,V>

com.google.common.collect.StandardTable<R,C,V>

All Implemented Interfaces:

Table<R,C,V>, java.io.Serializable

Direct Known Subclasses:

HashBasedTable, StandardRowSortedTable

@GwtCompatible
class StandardTable<R,C,V>
extends AbstractTable<R,C,V>
implements java.io.Serializable

Table implementation backed by a map that associates row keys with column key / value secondary maps. This class provides rapid access to records by the row key alone or by both keys, but not by just the column key.

The views returned by column(C), columnKeySet(), and columnMap() have iterators that don't support remove(). Otherwise, all optional operations are supported. Null row keys, columns keys, and values are not supported.

Lookups by row key are often faster than lookups by column key, because the data is stored in a Map<R, Map<C, V>>. A method call like column(columnKey).get(rowKey) still runs quickly, since the row key is provided. However, column(columnKey).size() takes longer, since an iteration across all row keys occurs.

Note that this implementation is not synchronized. If multiple threads access this table concurrently and one of the threads modifies the table, it must be synchronized externally.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	StandardTable.CellIterator
private class	StandardTable.Column
private class	StandardTable.ColumnKeyIterator
private class	StandardTable.ColumnKeySet
private class	StandardTable.ColumnMap
(package private) class	StandardTable.Row
(package private) class	StandardTable.RowMap
private class	StandardTable.TableSet<T> Abstract set whose isEmpty() returns whether the table is empty and whose clear() clears all table mappings.

Nested classes/interfaces inherited from class com.google.common.collect.AbstractTable

AbstractTable.CellSet, AbstractTable.Values

Nested classes/interfaces inherited from interface com.google.common.collect.Table

Table.Cell<R,C,V>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.Map<R,java.util.Map<C,V>>	backingMap
private java.util.Set<C>	columnKeySet
private StandardTable.ColumnMap	columnMap
(package private) Supplier<? extends java.util.Map<C,V>>	factory
private java.util.Map<R,java.util.Map<C,V>>	rowMap
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
StandardTable(java.util.Map<R,java.util.Map<C,V>> backingMap, Supplier<? extends java.util.Map<C,V>> factory)

Method Summary

Modifier and Type	Method and Description
(package private) java.util.Iterator<Table.Cell<R,C,V>>	cellIterator()
java.util.Set<Table.Cell<R,C,V>>	cellSet() Returns a set of all row key / column key / value triplets.
void	clear() Removes all mappings from the table.
java.util.Map<R,V>	column(C columnKey) Returns a view of all mappings that have the given column key.
java.util.Set<C>	columnKeySet() Returns a set of column keys that have one or more values in the table.
java.util.Map<C,java.util.Map<R,V>>	columnMap() Returns a view that associates each column key with the corresponding map from row keys to values.
boolean	contains(java.lang.Object rowKey, java.lang.Object columnKey) Returns true if the table contains a mapping with the specified row and column keys.
boolean	containsColumn(java.lang.Object columnKey) Returns true if the table contains a mapping with the specified column.
private boolean	containsMapping(java.lang.Object rowKey, java.lang.Object columnKey, java.lang.Object value)
boolean	containsRow(java.lang.Object rowKey) Returns true if the table contains a mapping with the specified row key.
boolean	containsValue(java.lang.Object value) Returns true if the table contains a mapping with the specified value.
(package private) java.util.Iterator<C>	createColumnKeyIterator() Creates an iterator that returns each column value with duplicates omitted.
(package private) java.util.Map<R,java.util.Map<C,V>>	createRowMap()
V	get(java.lang.Object rowKey, java.lang.Object columnKey) Returns the value corresponding to the given row and column keys, or null if no such mapping exists.
private java.util.Map<C,V>	getOrCreate(R rowKey)
boolean	isEmpty() Returns true if the table contains no mappings.
V	put(R rowKey, C columnKey, V value) Associates the specified value with the specified keys.
V	remove(java.lang.Object rowKey, java.lang.Object columnKey) Removes the mapping, if any, associated with the given keys.
private java.util.Map<R,V>	removeColumn(java.lang.Object column)
private boolean	removeMapping(java.lang.Object rowKey, java.lang.Object columnKey, java.lang.Object value) Remove a row key / column key / value mapping, if present.
java.util.Map<C,V>	row(R rowKey) Returns a view of all mappings that have the given row key.
java.util.Set<R>	rowKeySet() Returns a set of row keys that have one or more values in the table.
java.util.Map<R,java.util.Map<C,V>>	rowMap() Returns a view that associates each row key with the corresponding map from column keys to values.
int	size() Returns the number of row key / column key / value mappings in the table.
java.util.Collection<V>	values() Returns a collection of all values, which may contain duplicates.

Methods inherited from class com.google.common.collect.AbstractTable

createCellSet, createValues, equals, hashCode, putAll, toString, valuesIterator

Methods inherited from class java.lang.Object

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

Field Detail

backingMap

@GwtTransient
final java.util.Map<R,java.util.Map<C,V>> backingMap

factory

@GwtTransient
final Supplier<? extends java.util.Map<C,V>> factory

columnKeySet

private transient java.util.Set<C> columnKeySet

rowMap

private transient java.util.Map<R,java.util.Map<C,V>> rowMap

columnMap

private transient StandardTable.ColumnMap columnMap

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

StandardTable

StandardTable(java.util.Map<R,java.util.Map<C,V>> backingMap,
              Supplier<? extends java.util.Map<C,V>> factory)

Method Detail

contains

public boolean contains(@Nullable
                        java.lang.Object rowKey,
                        @Nullable
                        java.lang.Object columnKey)

Description copied from interface: Table

Returns true if the table contains a mapping with the specified row and column keys.

Specified by:

contains in interface Table<R,C,V>

Overrides:

contains in class AbstractTable<R,C,V>

Parameters:

rowKey - key of row to search for

columnKey - key of column to search for

containsColumn

public boolean containsColumn(@Nullable
                              java.lang.Object columnKey)

Description copied from interface: Table

Returns true if the table contains a mapping with the specified column.

Specified by:

containsColumn in interface Table<R,C,V>

Overrides:

containsColumn in class AbstractTable<R,C,V>

Parameters:

columnKey - key of column to search for

containsRow

public boolean containsRow(@Nullable
                           java.lang.Object rowKey)

Description copied from interface: Table

Returns true if the table contains a mapping with the specified row key.

Specified by:

containsRow in interface Table<R,C,V>

Overrides:

containsRow in class AbstractTable<R,C,V>

Parameters:

rowKey - key of row to search for

containsValue

public boolean containsValue(@Nullable
                             java.lang.Object value)

Description copied from interface: Table

Returns true if the table contains a mapping with the specified value.

Specified by:

containsValue in interface Table<R,C,V>

Overrides:

containsValue in class AbstractTable<R,C,V>

Parameters:

value - value to search for

get

public V get(@Nullable
             java.lang.Object rowKey,
             @Nullable
             java.lang.Object columnKey)

Description copied from interface: Table

Returns the value corresponding to the given row and column keys, or null if no such mapping exists.

Specified by:

get in interface Table<R,C,V>

Overrides:

get in class AbstractTable<R,C,V>

Parameters:

rowKey - key of row to search for

columnKey - key of column to search for

isEmpty

public boolean isEmpty()

Description copied from interface: Table

Returns true if the table contains no mappings.

Specified by:

isEmpty in interface Table<R,C,V>

Overrides:

isEmpty in class AbstractTable<R,C,V>

size

public int size()

Description copied from interface: Table

Returns the number of row key / column key / value mappings in the table.

Specified by:

size in interface Table<R,C,V>

clear

public void clear()

Description copied from interface: Table

Removes all mappings from the table.

Specified by:

clear in interface Table<R,C,V>

Overrides:

clear in class AbstractTable<R,C,V>

getOrCreate

private java.util.Map<C,V> getOrCreate(R rowKey)

put

public V put(R rowKey,
             C columnKey,
             V value)

Description copied from interface: Table

Associates the specified value with the specified keys. If the table already contained a mapping for those keys, the old value is replaced with the specified value.

Specified by:

put in interface Table<R,C,V>

Overrides:

put in class AbstractTable<R,C,V>

Parameters:

rowKey - row key that the value should be associated with

columnKey - column key that the value should be associated with

value - value to be associated with the specified keys

Returns:

the value previously associated with the keys, or null if no mapping existed for the keys

remove

public V remove(@Nullable
                java.lang.Object rowKey,
                @Nullable
                java.lang.Object columnKey)

Description copied from interface: Table

Removes the mapping, if any, associated with the given keys.

Specified by:

remove in interface Table<R,C,V>

Overrides:

remove in class AbstractTable<R,C,V>

Parameters:

rowKey - row key of mapping to be removed

columnKey - column key of mapping to be removed

Returns:

the value previously associated with the keys, or null if no such value existed

removeColumn

private java.util.Map<R,V> removeColumn(java.lang.Object column)

containsMapping

private boolean containsMapping(java.lang.Object rowKey,
                                java.lang.Object columnKey,
                                java.lang.Object value)

removeMapping

private boolean removeMapping(java.lang.Object rowKey,
                              java.lang.Object columnKey,
                              java.lang.Object value)

Remove a row key / column key / value mapping, if present.

cellSet

public java.util.Set<Table.Cell<R,C,V>> cellSet()

Returns a set of all row key / column key / value triplets. Changes to the returned set will update the underlying table, and vice versa. The cell set does not support the add or addAll methods.

The set's iterator traverses the mappings for the first row, the mappings for the second row, and so on.

Each cell is an immutable snapshot of a row key / column key / value mapping, taken at the time the cell is returned by a method call to the set or its iterator.

Specified by:

cellSet in interface Table<R,C,V>

Overrides:

cellSet in class AbstractTable<R,C,V>

Returns:

set of table cells consisting of row key / column key / value triplets

cellIterator

java.util.Iterator<Table.Cell<R,C,V>> cellIterator()

Specified by:

cellIterator in class AbstractTable<R,C,V>

row

public java.util.Map<C,V> row(R rowKey)

Description copied from interface: Table

Returns a view of all mappings that have the given row key. For each row key / column key / value mapping in the table with that row key, the returned map associates the column key with the value. If no mappings in the table have the provided row key, an empty map is returned.

Changes to the returned map will update the underlying table, and vice versa.

Specified by:

row in interface Table<R,C,V>

Parameters:

rowKey - key of row to search for in the table

Returns:

the corresponding map from column keys to values

column

public java.util.Map<R,V> column(C columnKey)

Returns a view of all mappings that have the given column key. For each row key / column key / value mapping in the table with that column key, the returned map associates the row key with the value. If no mappings in the table have the provided column key, an empty map is returned.

Changes to the returned map will update the underlying table, and vice versa.

The returned map's views have iterators that don't support remove().

Specified by:

column in interface Table<R,C,V>

Parameters:

columnKey - key of column to search for in the table

Returns:

the corresponding map from row keys to values

rowKeySet

public java.util.Set<R> rowKeySet()

Description copied from interface: Table

Returns a set of row keys that have one or more values in the table. Changes to the set will update the underlying table, and vice versa.

Specified by:

rowKeySet in interface Table<R,C,V>

Overrides:

rowKeySet in class AbstractTable<R,C,V>

Returns:

set of row keys

columnKeySet

public java.util.Set<C> columnKeySet()

Returns a set of column keys that have one or more values in the table. Changes to the set will update the underlying table, and vice versa.

The returned set has an iterator that does not support remove().

The set's iterator traverses the columns of the first row, the columns of the second row, etc., skipping any columns that have appeared previously.

Specified by:

columnKeySet in interface Table<R,C,V>

Overrides:

columnKeySet in class AbstractTable<R,C,V>

Returns:

set of column keys

createColumnKeyIterator

java.util.Iterator<C> createColumnKeyIterator()

Creates an iterator that returns each column value with duplicates omitted.

values

public java.util.Collection<V> values()

Returns a collection of all values, which may contain duplicates. Changes to the returned collection will update the underlying table, and vice versa.

The collection's iterator traverses the values for the first row, the values for the second row, and so on.

Specified by:

values in interface Table<R,C,V>

Overrides:

values in class AbstractTable<R,C,V>

Returns:

collection of values

rowMap

public java.util.Map<R,java.util.Map<C,V>> rowMap()

Description copied from interface: Table

Returns a view that associates each row key with the corresponding map from column keys to values. Changes to the returned map will update this table. The returned map does not support put() or putAll(), or setValue() on its entries.

In contrast, the maps returned by rowMap().get() have the same behavior as those returned by Table.row(R). Those maps may support setValue(), put(), and putAll().

Specified by:

rowMap in interface Table<R,C,V>

Returns:

a map view from each row key to a secondary map from column keys to values

createRowMap

java.util.Map<R,java.util.Map<C,V>> createRowMap()

columnMap

public java.util.Map<C,java.util.Map<R,V>> columnMap()

Description copied from interface: Table

Returns a view that associates each column key with the corresponding map from row keys to values. Changes to the returned map will update this table. The returned map does not support put() or putAll(), or setValue() on its entries.

In contrast, the maps returned by columnMap().get() have the same behavior as those returned by Table.column(C). Those maps may support setValue(), put(), and putAll().

Specified by:

columnMap in interface Table<R,C,V>

Returns:

a map view from each column key to a secondary map from row keys to values