    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.label;
    034
    035import com.orsoncharts.data.category.CategoryDataset3D;
    036import com.orsoncharts.plot.CategoryPlot3D;
    037
    038/**
    039 * A label generator for category charts, used to create labels for the axes
    040 * and for the chart legend.  The ({@link StandardCategoryLabelGenerator}) class
    041 * provides the default implementation.
    042 * <br><br>
    043 * Note that a different generator is used for <strong>item labels</strong> in
    044 * a {@link CategoryPlot3D} - see the {@link CategoryItemLabelGenerator}
    045 * interface.
    046 *
    047 * @since 1.2
    048 */
    049public interface CategoryLabelGenerator {
    050
    051    /**
    052     * Generates a label for one series in a {@link CategoryDataset3D}.
    053     *
    054     * @param dataset  the dataset ({@code null} not permitted).
    055     * @param seriesKey  the series key ({@code null} not permitted).
    056     *
    057     * @return The series label (possibly {@code null}).
    058     */
    059    String generateSeriesLabel(CategoryDataset3D dataset,
    060            Comparable<?> seriesKey);
    061
    062    /**
    063     * Generates a label for one row in a {@link CategoryDataset3D}.
    064     *
    065     * @param dataset  the dataset ({@code null} not permitted).
    066     * @param rowKey  the key ({@code null} not permitted).
    067     *
    068     * @return The row label (possibly {@code null}).
    069     */
    070    String generateRowLabel(CategoryDataset3D dataset, Comparable<?> rowKey);
    071
    072    /**
    073     * Generates a label for one column in a {@link CategoryDataset3D}.
    074     *
    075     * @param dataset  the dataset ({@code null} not permitted).
    076     * @param columnKey  the key ({@code null} not permitted).
    077     *
    078     * @return The column label (possibly {@code null}).
    079     */
    080    String generateColumnLabel(CategoryDataset3D dataset,
    081            Comparable<?> columnKey);
    082
    083}