org.jfree.chart3d.data.Values3D Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.jfree.chart3d Show documentation
Show all versions of org.jfree.chart3d Show documentation
Orson Charts is a 3D chart library for the Java platform.
/* ===========================================================
* Orson Charts : a 3D chart library for the Java(tm) platform
* ===========================================================
*
* (C)opyright 2013-2020, by Object Refinery Limited. All rights reserved.
*
* https://github.com/jfree/orson-charts
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* If you do not wish to be bound by the terms of the GPL, an alternative
* commercial license can be purchased. For details, please see visit the
* Orson Charts home page:
*
* http://www.object-refinery.com/orsoncharts/index.html
*
*/
package org.jfree.chart3d.data;
/**
* A generic representation of a three dimensional grid (cube) of data values.
* We refer to the indices in the three dimensions as the
* {@code seriesIndex}, the {@code rowIndex} and the
* {@code columnIndex} (to match the downstream use of this data
* structure to represent data values in a three dimensional plot).
*
* @param The value type (normally a numeric type).
*
* @see KeyedValues3D
*/
public interface Values3D {
/**
* Returns the number of items in the x-dimension.
*
* @return The number of items in the x-dimension.
*/
int getSeriesCount();
/**
* Returns the number of items in the y-dimension.
*
* @return The number of items in the y-dimension.
*/
int getRowCount();
/**
* Returns the number of items in the z-dimension.
*
* @return The number of items in the z-dimension.
*/
int getColumnCount();
/**
* Returns the data item at the specified position.
*
* @param seriesIndex the series-index.
* @param rowIndex the row-index.
* @param columnIndex the column-index.
*
* @return The data value (possibly {@code null}).
*/
T getValue(int seriesIndex, int rowIndex, int columnIndex);
/**
* Returns the data item at the specified position as a double primitive.
* Where the {@link #getValue(int, int, int) } method returns
* {@code null}, this method returns {@code Double.NaN}.
*
* @param seriesIndex the series index.
* @param rowIndex the row index.
* @param columnIndex the column index.
*
* @return The data value.
*/
double getDoubleValue(int seriesIndex, int rowIndex, int columnIndex);
}