/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2011, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* -------------------------
* GanttCategoryDataset.java
* -------------------------
* (C) Copyright 2003-2008, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 16-Sep-2003 : Version 1, based on MultiIntervalCategoryDataset (DG);
* 23-Sep-2003 : Fixed Checkstyle issues (DG);
* 12-May-2008 : Updated API docs (DG);
*
*/
package org.jfree.data.gantt;
import org.jfree.data.category.IntervalCategoryDataset;
/**
* An extension of the {@link IntervalCategoryDataset} interface that adds
* support for multiple sub-intervals.
*/
public interface GanttCategoryDataset extends IntervalCategoryDataset {
/**
* Returns the percent complete for a given item.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
*
* @return The percent complete.
*
* @see #getPercentComplete(Comparable, Comparable)
*/
public Number getPercentComplete(int row, int column);
/**
* Returns the percent complete for a given item.
*
* @param rowKey the row key.
* @param columnKey the column key.
*
* @return The percent complete.
*
* @see #getPercentComplete(int, int)
*/
public Number getPercentComplete(Comparable rowKey, Comparable columnKey);
/**
* Returns the number of sub-intervals for a given item.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
*
* @return The sub-interval count.
*
* @see #getSubIntervalCount(Comparable, Comparable)
*/
public int getSubIntervalCount(int row, int column);
/**
* Returns the number of sub-intervals for a given item.
*
* @param rowKey the row key.
* @param columnKey the column key.
*
* @return The sub-interval count.
*
* @see #getSubIntervalCount(int, int)
*/
public int getSubIntervalCount(Comparable rowKey, Comparable columnKey);
/**
* Returns the start value of a sub-interval for a given item.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
* @param subinterval the sub-interval index (zero-based).
*
* @return The start value (possibly <code>null</code>).
*
* @see #getEndValue(int, int, int)
*/
public Number getStartValue(int row, int column, int subinterval);
/**
* Returns the start value of a sub-interval for a given item.
*
* @param rowKey the row key.
* @param columnKey the column key.
* @param subinterval the sub-interval.
*
* @return The start value (possibly <code>null</code>).
*
* @see #getEndValue(Comparable, Comparable, int)
*/
public Number getStartValue(Comparable rowKey, Comparable columnKey,
int subinterval);
/**
* Returns the end value of a sub-interval for a given item.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
* @param subinterval the sub-interval.
*
* @return The end value (possibly <code>null</code>).
*
* @see #getStartValue(int, int, int)
*/
public Number getEndValue(int row, int column, int subinterval);
/**
* Returns the end value of a sub-interval for a given item.
*
* @param rowKey the row key.
* @param columnKey the column key.
* @param subinterval the sub-interval.
*
* @return The end value (possibly <code>null</code>).
*
* @see #getStartValue(Comparable, Comparable, int)
*/
public Number getEndValue(Comparable rowKey, Comparable columnKey,
int subinterval);
/**
* Returns the percentage complete value of a sub-interval for a given item.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
* @param subinterval the sub-interval.
*
* @return The percent complete value (possibly <code>null</code>).
*
* @see #getPercentComplete(Comparable, Comparable, int)
*/
public Number getPercentComplete(int row, int column, int subinterval);
/**
* Returns the percentage complete value of a sub-interval for a given item.
*
* @param rowKey the row key.
* @param columnKey the column key.
* @param subinterval the sub-interval.
*
* @return The percent complete value (possibly <code>null</code>).
*
* @see #getPercentComplete(int, int, int)
*/
public Number getPercentComplete(Comparable rowKey, Comparable columnKey,
int subinterval);
}
|