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()
, andcolumnMap()
have iterators that don't supportremove()
. 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 likecolumn(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 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 whoseisEmpty()
returns whether the table is empty and whoseclear()
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 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
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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)
Returnstrue
if the table contains a mapping with the specified row and column keys.boolean
containsColumn(java.lang.Object columnKey)
Returnstrue
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)
Returnstrue
if the table contains a mapping with the specified row key.boolean
containsValue(java.lang.Object value)
Returnstrue
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, ornull
if no such mapping exists.private java.util.Map<C,V>
getOrCreate(R rowKey)
boolean
isEmpty()
Returnstrue
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
-
-
-
-
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
-
columnMap
private transient StandardTable.ColumnMap columnMap
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
contains
public boolean contains(@Nullable java.lang.Object rowKey, @Nullable java.lang.Object columnKey)
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified row and column keys.
-
containsColumn
public boolean containsColumn(@Nullable java.lang.Object columnKey)
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified column.- Specified by:
containsColumn
in interfaceTable<R,C,V>
- Overrides:
containsColumn
in classAbstractTable<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
Returnstrue
if the table contains a mapping with the specified row key.- Specified by:
containsRow
in interfaceTable<R,C,V>
- Overrides:
containsRow
in classAbstractTable<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
Returnstrue
if the table contains a mapping with the specified value.- Specified by:
containsValue
in interfaceTable<R,C,V>
- Overrides:
containsValue
in classAbstractTable<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, ornull
if no such mapping exists.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Table
Returnstrue
if the table contains no mappings.
-
size
public int size()
Description copied from interface:Table
Returns the number of row key / column key / value mappings in the table.
-
clear
public void clear()
Description copied from interface:Table
Removes all mappings from the table.
-
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 interfaceTable<R,C,V>
- Overrides:
put
in classAbstractTable<R,C,V>
- Parameters:
rowKey
- row key that the value should be associated withcolumnKey
- column key that the value should be associated withvalue
- 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.
-
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 theadd
oraddAll
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.
-
cellIterator
java.util.Iterator<Table.Cell<R,C,V>> cellIterator()
- Specified by:
cellIterator
in classAbstractTable<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.
-
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()
.
-
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.
-
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 interfaceTable<R,C,V>
- Overrides:
columnKeySet
in classAbstractTable<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.
-
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 supportput()
orputAll()
, orsetValue()
on its entries.In contrast, the maps returned by
rowMap().get()
have the same behavior as those returned byTable.row(R)
. Those maps may supportsetValue()
,put()
, andputAll()
.
-
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 supportput()
orputAll()
, orsetValue()
on its entries.In contrast, the maps returned by
columnMap().get()
have the same behavior as those returned byTable.column(C)
. Those maps may supportsetValue()
,put()
, andputAll()
.
-
-