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.label; 034 035import org.jfree.chart3d.data.category.CategoryDataset3D; 036 037/** 038 * An item label generator for category charts (this is used for tooltips and 039 * data item labels). Note that this generator is used for individual data 040 * items, and is distinct from the {@link CategoryLabelGenerator} which 041 * generates labels for series keys, column keys and row keys. 042 * The {@link StandardCategoryItemLabelGenerator} class provides the default 043 * implementation. 044 * 045 * @since 1.3 046 */ 047public interface CategoryItemLabelGenerator { 048 049 /** 050 * Generates a label for one series in a {@link CategoryDataset3D}. 051 * 052 * @param dataset the dataset ({@code null} not permitted). 053 * @param seriesKey the series key ({@code null} not permitted). 054 * @param rowKey the row key ({@code null} not permitted). 055 * @param columnKey the column key ({@code null} not permitted). 056 * 057 * @return The series label (possibly {@code null}). 058 */ 059 String generateItemLabel(CategoryDataset3D dataset, 060 Comparable<?> seriesKey, Comparable<?> rowKey, 061 Comparable<?> columnKey); 062 063}