    001/* ===========================================================
    002 * Orson Charts : a 3D chart library for the Java(tm) platform
    003 * ===========================================================
    004 *
    005 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
    006 *
    007 * http://www.object-refinery.com/orsoncharts/index.html
    008 *
    009 * This program is free software: you can redistribute it and/or modify
    010 * it under the terms of the GNU General Public License as published by
    011 * the Free Software Foundation, either version 3 of the License, or
    012 * (at your option) any later version.
    013 *
    014 * This program is distributed in the hope that it will be useful,
    015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
    016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    017 * GNU General Public License for more details.
    018 *
    019 * You should have received a copy of the GNU General Public License
    020 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    021 *
    022 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
    023 * Other names may be trademarks of their respective owners.]
    024 *
    025 * If you do not wish to be bound by the terms of the GPL, an alternative
    026 * commercial license can be purchased.  For details, please see visit the
    027 * Orson Charts home page:
    028 *
    029 * http://www.object-refinery.com/orsoncharts/index.html
    030 *
    031 */
    032
    033package com.orsoncharts.interaction;
    034
    035import java.util.Set;
    036import java.util.TreeSet;
    037import java.util.Collection;
    038import com.orsoncharts.data.xyz.XYZDataset;
    039import com.orsoncharts.data.xyz.XYZItemKey;
    040import com.orsoncharts.util.ArgChecks;
    041
    042/**
    043 * An object that tracks selected items from an {@link XYZDataset}.
    044 *
    045 * @since 1.3
    046 */
    047public class StandardXYZDataItemSelection implements XYZDataItemSelection {
    048
    049    /** The selected items. */
    050    Set<XYZItemKey> selectedItems;
    051
    052    /**
    053     * Creates a new (empty) selection.
    054     */
    055    public StandardXYZDataItemSelection() {
    056        this.selectedItems = new TreeSet<XYZItemKey>();
    057    }
    058
    059    /**
    060     * Adds an item to the selection, returns {@code true} if the item
    061     * was added and {@code false} if it already existed in the selection.
    062     *
    063     * @param item  the item key ({@code null} not permitted).
    064     *
    065     * @return A boolean.
    066     */
    067    public boolean add(XYZItemKey item) {
    068        ArgChecks.nullNotPermitted(item, "item");
    069        return this.selectedItems.add(item);
    070    }
    071
    072    /**
    073     * Adds all the items from the specified collection, returning
    074     * {@code true} if the selection is updated or {@code false} if
    075     * all the supplied keys are already present in the selection.
    076     *
    077     * @param keys  the keys ({@code null} not permitted).
    078     *
    079     * @return A boolean.
    080     */
    081    public boolean addAll(Collection<XYZItemKey> keys) {
    082        ArgChecks.nullNotPermitted(keys, "keys");
    083        return this.selectedItems.addAll(keys);
    084    }
    085
    086    /**
    087     * Removes an item from the selection, returning {@code true} if the
    088     * item was removed and {@code false} if it was not present in the
    089     * selection.
    090     *
    091     * @param item  the item ({@code null} not permitted).
    092     *
    093     * @return A boolean.
    094     */
    095    public boolean remove(XYZItemKey item) {
    096        return this.selectedItems.remove(item);
    097    }
    098
    099    /**
    100     * Returns {@code true} if the item is present in the selection,
    101     * and {@code false} otherwise.
    102     *
    103     * @param item  the item {@code null} not permitted).
    104     *
    105     * @return A boolean.
    106     */
    107    @Override
    108    public boolean isSelected(XYZItemKey item) {
    109        return this.selectedItems.contains(item);
    110    }
    111
    112    /**
    113     * Clears the selection.
    114     */
    115    public void clear() {
    116        this.selectedItems.clear();
    117    }
    118
    119}