123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465 |
- /*
- * Copyright 2000-2016 Vaadin Ltd.
- *
- * 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.vaadin.v7.client.widget.grid.datasources;
-
- import java.util.ArrayList;
- import java.util.Arrays;
- import java.util.Collection;
- import java.util.Collections;
- import java.util.Comparator;
- import java.util.Iterator;
- import java.util.LinkedHashSet;
- import java.util.List;
- import java.util.ListIterator;
- import java.util.Objects;
- import java.util.Set;
- import java.util.stream.Stream;
-
- import com.vaadin.client.data.DataChangeHandler;
- import com.vaadin.client.data.DataSource;
- import com.vaadin.shared.Registration;
- import com.vaadin.shared.util.SharedUtil;
- import com.vaadin.v7.client.widget.grid.events.SelectAllEvent;
- import com.vaadin.v7.client.widget.grid.events.SelectAllHandler;
-
- /**
- * A simple list based on an in-memory data source for simply adding a list of
- * row pojos to the grid. Based on a wrapped list instance which supports adding
- * and removing of items.
- *
- * <p>
- * Usage:
- *
- * <pre>
- * ListDataSource<Integer> ds = new ListDataSource<Integer>(1, 2, 3, 4);
- *
- * // Add item to the data source
- * ds.asList().add(5);
- *
- * // Remove item from the data source
- * ds.asList().remove(3);
- *
- * // Add multiple items
- * ds.asList().addAll(Arrays.asList(5, 6, 7));
- * </pre>
- *
- * @since 7.4
- * @author Vaadin Ltd
- */
- public class ListDataSource<T> implements DataSource<T> {
-
- private class RowHandleImpl extends RowHandle<T> {
-
- private final T row;
-
- public RowHandleImpl(T row) {
- this.row = row;
- }
-
- @Override
- public T getRow() {
- /*
- * We'll cheat here and don't throw an IllegalStateException even if
- * this isn't pinned, because we know that the reference never gets
- * stale.
- */
- return row;
- }
-
- @Override
- public void pin() {
- // NOOP, really
- }
-
- @Override
- public void unpin() throws IllegalStateException {
- /*
- * Just to make things easier for everyone, we won't throw the
- * exception, even in illegal situations.
- */
- }
-
- @Override
- protected boolean equalsExplicit(Object obj) {
- if (obj instanceof ListDataSource.RowHandleImpl) {
- /*
- * Java prefers AbstractRemoteDataSource<?>.RowHandleImpl. I
- * like the @SuppressWarnings more (keeps the line length in
- * check.)
- */
- @SuppressWarnings("unchecked")
- RowHandleImpl rhi = (RowHandleImpl) obj;
- return SharedUtil.equals(row, rhi.row);
- } else {
- return false;
- }
- }
-
- @Override
- protected int hashCodeExplicit() {
- return row.hashCode();
- }
-
- @Override
- public void updateRow() {
- getHandlers()
- .forEach(dch -> dch.dataUpdated(ds.indexOf(getRow()), 1));
- }
- }
-
- /**
- * Wraps the datasource list and notifies the change handler of changing to
- * the list
- */
- private class ListWrapper implements List<T> {
-
- @Override
- public int size() {
- return ds.size();
- }
-
- @Override
- public boolean isEmpty() {
- return ds.isEmpty();
- }
-
- @Override
- public boolean contains(Object o) {
- return ds.contains(o);
- }
-
- @Override
- public Iterator<T> iterator() {
- return new ListWrapperIterator(ds.iterator());
- }
-
- @Override
- public Object[] toArray() {
- return ds.toArray();
- }
-
- @Override
- @SuppressWarnings("hiding")
- public <T> T[] toArray(T[] a) {
- return ds.toArray(a);
- }
-
- @Override
- public boolean add(T e) {
- if (ds.add(e)) {
- getHandlers().forEach(dch -> dch.dataAdded(ds.size() - 1, 1));
- return true;
- }
- return false;
- }
-
- @Override
- public boolean remove(Object o) {
- int index = ds.indexOf(o);
- if (ds.remove(o)) {
- getHandlers().forEach(dch -> dch.dataRemoved(index, 1));
- return true;
- }
- return false;
- }
-
- @Override
- public boolean containsAll(Collection<?> c) {
- return ds.containsAll(c);
- }
-
- @Override
- public boolean addAll(Collection<? extends T> c) {
- int idx = ds.size();
- if (ds.addAll(c)) {
- getHandlers().forEach(dch -> dch.dataAdded(idx, c.size()));
- return true;
- }
- return false;
- }
-
- @Override
- public boolean addAll(int index, Collection<? extends T> c) {
- if (ds.addAll(index, c)) {
- getHandlers().forEach(dch -> dch.dataAdded(index, c.size()));
- return true;
- }
- return false;
- }
-
- @Override
- public boolean removeAll(Collection<?> c) {
- if (ds.removeAll(c)) {
- getHandlers().forEach(dch -> dch.dataUpdated(0, ds.size()));
- getHandlers().forEach(dch -> dch.dataAvailable(0, ds.size()));
- return true;
- }
- return false;
- }
-
- @Override
- public boolean retainAll(Collection<?> c) {
- if (ds.retainAll(c)) {
- getHandlers().forEach(dch -> dch.dataUpdated(0, ds.size()));
- getHandlers().forEach(dch -> dch.dataAvailable(0, ds.size()));
- return true;
- }
- return false;
- }
-
- @Override
- public void clear() {
- int size = ds.size();
- ds.clear();
- getHandlers().forEach(dch -> dch.dataRemoved(0, size));
- }
-
- @Override
- public T get(int index) {
- return ds.get(index);
- }
-
- @Override
- public T set(int index, T element) {
- T prev = ds.set(index, element);
- getHandlers().forEach(dch -> dch.dataUpdated(index, 1));
- return prev;
- }
-
- @Override
- public void add(int index, T element) {
- ds.add(index, element);
- getHandlers().forEach(dch -> dch.dataAdded(index, 1));
- }
-
- @Override
- public T remove(int index) {
- T removed = ds.remove(index);
- getHandlers().forEach(dch -> dch.dataRemoved(index, 1));
- return removed;
- }
-
- @Override
- public int indexOf(Object o) {
- return ds.indexOf(o);
- }
-
- @Override
- public int lastIndexOf(Object o) {
- return ds.lastIndexOf(o);
- }
-
- @Override
- public ListIterator<T> listIterator() {
- // TODO could be implemented by a custom iterator.
- throw new UnsupportedOperationException(
- "List iterators not supported at this time.");
- }
-
- @Override
- public ListIterator<T> listIterator(int index) {
- // TODO could be implemented by a custom iterator.
- throw new UnsupportedOperationException(
- "List iterators not supported at this time.");
- }
-
- @Override
- public List<T> subList(int fromIndex, int toIndex) {
- throw new UnsupportedOperationException("Sub lists not supported.");
- }
- }
-
- /**
- * Iterator returned by {@link ListWrapper}
- */
- private class ListWrapperIterator implements Iterator<T> {
-
- private final Iterator<T> iterator;
-
- /**
- * Constructs a new iterator
- */
- public ListWrapperIterator(Iterator<T> iterator) {
- this.iterator = iterator;
- }
-
- @Override
- public boolean hasNext() {
- return iterator.hasNext();
- }
-
- @Override
- public T next() {
- return iterator.next();
- }
-
- @Override
- public void remove() {
- throw new UnsupportedOperationException(
- "Iterator.remove() is not supported by this iterator.");
- }
- }
-
- /**
- * Datasource for providing row pojo's
- */
- private final List<T> ds;
-
- /**
- * Wrapper that wraps the data source
- */
- private final ListWrapper wrapper;
-
- /**
- * Handler for listening to changes in the underlying list.
- */
- private Set<DataChangeHandler> changeHandlers = new LinkedHashSet<>();
-
- /**
- * Constructs a new list data source.
- * <p>
- * Note: Modifications to the original list will not be reflected in the
- * data source after the data source has been constructed. To add or remove
- * items to the data source after it has been constructed use
- * {@link ListDataSource#asList()}.
- *
- *
- * @param datasource
- * The list to use for providing the data to the grid
- */
- public ListDataSource(List<T> datasource) {
- if (datasource == null) {
- throw new IllegalArgumentException("datasource cannot be null");
- }
- ds = new ArrayList<T>(datasource);
- wrapper = new ListWrapper();
- }
-
- /**
- * Constructs a data source with a set of rows. You can dynamically add and
- * remove rows from the data source via the list you get from
- * {@link ListDataSource#asList()}
- *
- * @param rows
- * The rows to initially add to the data source
- */
- public ListDataSource(T... rows) {
- if (rows == null) {
- ds = new ArrayList<T>();
- } else {
- ds = new ArrayList<T>(Arrays.asList(rows));
- }
- wrapper = new ListWrapper();
- }
-
- @Override
- public void ensureAvailability(int firstRowIndex, int numberOfRows) {
- if (firstRowIndex >= ds.size()) {
- throw new IllegalStateException(
- "Trying to fetch rows outside of array");
- }
-
- getHandlers()
- .forEach(dch -> dch.dataAvailable(firstRowIndex, numberOfRows));
- }
-
- @Override
- public T getRow(int rowIndex) {
- return ds.get(rowIndex);
- }
-
- @Override
- public int size() {
- return ds.size();
- }
-
- @Override
- public Registration addDataChangeHandler(
- DataChangeHandler dataChangeHandler) {
- Objects.requireNonNull(dataChangeHandler,
- "DataChangeHandler can't be null");
- changeHandlers.add(dataChangeHandler);
- return () -> changeHandlers.remove(dataChangeHandler);
- }
-
- /**
- * Gets the list that backs this datasource. Any changes made to this list
- * will be reflected in the datasource.
- * <p>
- * Note: The list is not the same list as passed into the data source via
- * the constructor.
- *
- * @return Returns a list implementation that wraps the real list that backs
- * the data source and provides events for the data source
- * listeners.
- */
- public List<T> asList() {
- return wrapper;
- }
-
- @Override
- public RowHandle<T> getHandle(T row) throws IllegalStateException {
- assert ds.contains(row) : "This data source doesn't contain the row "
- + row;
- return new RowHandleImpl(row);
- }
-
- /**
- * Sort entire container according to a {@link Comparator}.
- *
- * @param comparator
- * a comparator object, which compares two data source entries
- * (beans/pojos)
- */
- public void sort(Comparator<T> comparator) {
- Collections.sort(ds, comparator);
- getHandlers().forEach(dch -> dch.dataUpdated(0, ds.size()));
- }
-
- /**
- * Retrieves the index for given row object.
- * <p>
- * <em>Note:</em> This method does not verify that the given row object
- * exists at all in this DataSource.
- *
- * @param row
- * the row object
- * @return index of the row; or <code>-1</code> if row is not available
- */
- public int indexOf(T row) {
- return ds.indexOf(row);
- }
-
- /**
- * Returns a {@link SelectAllHandler} for this ListDataSource.
- *
- * @return select all handler
- */
- public SelectAllHandler<T> getSelectAllHandler() {
- return new SelectAllHandler<T>() {
- @Override
- public void onSelectAll(SelectAllEvent<T> event) {
- event.getSelectionModel().select(asList());
- }
- };
- }
-
- private Stream<DataChangeHandler> getHandlers() {
- Set<DataChangeHandler> copy = new LinkedHashSet<>(changeHandlers);
- return copy.stream();
- }
-
- }
|