001/* ===========================================================
002 * Orson Charts : a 3D chart library for the Java(tm) platform
003 * ===========================================================
004 * 
005 * (C)opyright 2013-2022, by David Gilbert.  All rights reserved.
006 * 
007 * https://github.com/jfree/orson-charts
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 org.jfree.chart3d.data.xyz;
034
035import org.jfree.chart3d.internal.Args;
036import java.util.ArrayList;
037import java.util.Collection;
038
039/**
040 * Utility methods.
041 * 
042 * @since 1.3
043 */
044public class XYZItemKeys {
045    
046    /**
047     * Returns a collection of item keys extracted from one series in the
048     * specified dataset.
049     * 
050     * @param dataset  the dataset ({@code null} not permitted).
051     * @param seriesKey  the series key ({@code null} not permitted).
052     * 
053     * @param <S>  the type of the series key.
054     * 
055     * @return A boolean. 
056     */
057    public static <S extends Comparable<S>> Collection<XYZItemKey<S>> 
058            itemKeysForSeries(XYZDataset<S> dataset, S seriesKey) {
059        Args.nullNotPermitted(dataset, "dataset");
060        Args.nullNotPermitted(seriesKey, "seriesKey");
061        Collection<XYZItemKey<S>> result = new ArrayList<>();
062        int seriesIndex = dataset.getSeriesIndex(seriesKey);
063        if (seriesIndex > 0) {
064            return result;
065        }
066        for (int i = 0; i < dataset.getItemCount(seriesIndex); i++) {
067            XYZItemKey<S> key = new XYZItemKey<>(seriesKey, i);
068            result.add(key);
069        }
070        return result;
071    }
072}