com.google.common.collect.RegularImmutableTable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of guava-gwt Show documentation
Show all versions of guava-gwt Show documentation
Guava is a suite of core and expanded libraries that include
utility classes, Google's collections, I/O classes, and
much more.
This project includes GWT-friendly sources.
/*
* Copyright (C) 2009 The Guava Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.common.collect;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.common.annotations.GwtCompatible;
import com.google.j2objc.annotations.WeakOuter;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* An implementation of {@link ImmutableTable} holding an arbitrary number of cells.
*
* @author Gregory Kick
*/
@GwtCompatible
abstract class RegularImmutableTable extends ImmutableTable {
RegularImmutableTable() {}
abstract Cell getCell(int iterationIndex);
@Override
final ImmutableSet> createCellSet() {
return isEmpty() ? ImmutableSet.>of() : new CellSet();
}
@WeakOuter
private final class CellSet extends IndexedImmutableSet> {
@Override
public int size() {
return RegularImmutableTable.this.size();
}
@Override
Cell get(int index) {
return getCell(index);
}
@Override
public boolean contains(@Nullable Object object) {
if (object instanceof Cell) {
Cell cell = (Cell) object;
Object value = RegularImmutableTable.this.get(cell.getRowKey(), cell.getColumnKey());
return value != null && value.equals(cell.getValue());
}
return false;
}
@Override
boolean isPartialView() {
return false;
}
}
abstract V getValue(int iterationIndex);
@Override
final ImmutableCollection createValues() {
return isEmpty() ? ImmutableList.of() : new Values();
}
@WeakOuter
private final class Values extends ImmutableList {
@Override
public int size() {
return RegularImmutableTable.this.size();
}
@Override
public V get(int index) {
return getValue(index);
}
@Override
boolean isPartialView() {
return true;
}
}
static RegularImmutableTable forCells(
List> cells,
final @Nullable Comparator rowComparator,
final @Nullable Comparator columnComparator) {
checkNotNull(cells);
if (rowComparator != null || columnComparator != null) {
/*
* This sorting logic leads to a cellSet() ordering that may not be expected and that isn't
* documented in the Javadoc. If a row Comparator is provided, cellSet() iterates across the
* columns in the first row, the columns in the second row, etc. If a column Comparator is
* provided but a row Comparator isn't, cellSet() iterates across the rows in the first
* column, the rows in the second column, etc.
*/
Comparator> comparator =
new Comparator>() {
@Override
public int compare(Cell cell1, Cell cell2) {
int rowCompare =
(rowComparator == null)
? 0
: rowComparator.compare(cell1.getRowKey(), cell2.getRowKey());
if (rowCompare != 0) {
return rowCompare;
}
return (columnComparator == null)
? 0
: columnComparator.compare(cell1.getColumnKey(), cell2.getColumnKey());
}
};
Collections.sort(cells, comparator);
}
return forCellsInternal(cells, rowComparator, columnComparator);
}
static RegularImmutableTable forCells(Iterable> cells) {
return forCellsInternal(cells, null, null);
}
private static RegularImmutableTable forCellsInternal(
Iterable> cells,
@Nullable Comparator rowComparator,
@Nullable Comparator columnComparator) {
Set rowSpaceBuilder = new LinkedHashSet<>();
Set columnSpaceBuilder = new LinkedHashSet<>();
ImmutableList> cellList = ImmutableList.copyOf(cells);
for (Cell cell : cells) {
rowSpaceBuilder.add(cell.getRowKey());
columnSpaceBuilder.add(cell.getColumnKey());
}
ImmutableSet rowSpace =
(rowComparator == null)
? ImmutableSet.copyOf(rowSpaceBuilder)
: ImmutableSet.copyOf(ImmutableList.sortedCopyOf(rowComparator, rowSpaceBuilder));
ImmutableSet columnSpace =
(columnComparator == null)
? ImmutableSet.copyOf(columnSpaceBuilder)
: ImmutableSet.copyOf(ImmutableList.sortedCopyOf(columnComparator, columnSpaceBuilder));
return forOrderedComponents(cellList, rowSpace, columnSpace);
}
/** A factory that chooses the most space-efficient representation of the table. */
static RegularImmutableTable forOrderedComponents(
ImmutableList> cellList,
ImmutableSet rowSpace,
ImmutableSet columnSpace) {
// use a dense table if more than half of the cells have values
// TODO(gak): tune this condition based on empirical evidence
return (cellList.size() > (((long) rowSpace.size() * columnSpace.size()) / 2))
? new DenseImmutableTable(cellList, rowSpace, columnSpace)
: new SparseImmutableTable(cellList, rowSpace, columnSpace);
}
/** @throws IllegalArgumentException if {@code existingValue} is not null. */
/*
* We could have declared this method 'static' but the additional compile-time checks achieved by
* referencing the type variables seem worthwhile.
*/
final void checkNoDuplicate(R rowKey, C columnKey, V existingValue, V newValue) {
checkArgument(
existingValue == null,
"Duplicate key: (row=%s, column=%s), values: [%s, %s].",
rowKey,
columnKey,
newValue,
existingValue);
}
}