Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#1117 Improved JavaDoc for DomainInfo

1.0.x
closed-accepted
David Gilbert
javadoc (1)
5
2013-08-02
2013-07-31
David Tonhofer
No

Updated doc of DomainInfo to say something about NaNs to be returned if there are no values (at least according to the examples; there is nothing about that in the documentation either). Also added an indication in the header about what happens if the class isn't there!

package org.jfree.data;

/**
 * An interface (optional) that can be implemented by a dataset to assist in
 * determining the minimum and maximum values. If not present, DatasetUtilities
 * will iterate over all the values in the dataset to get the bounds.
 */

public interface DomainInfo {

    /**
     * Returns the minimum x-value in the dataset.
     *
     * @param includeInterval  a flag that determines whether or not the
     *                         x-interval is taken into account.
     *
     * @return The minimum value or Double.NaN if there are no values.
     */
    public double getDomainLowerBound(boolean includeInterval);

    /**
     * Returns the maximum x-value in the dataset.
     *
     * @param includeInterval  a flag that determines whether or not the
     *                         x-interval is taken into account.
     *
     * @return The maximum value or Double.NaN if there are no values.
     */
    public double getDomainUpperBound(boolean includeInterval);

    /**
     * Returns the range of the values in this dataset's domain.
     *
     * @param includeInterval  a flag that determines whether or not the
     *                         x-interval is taken into account.
     *
     * @return The range (or <code>null</code> if the dataset contains no
     *     values).
     */
    public Range getDomainBounds(boolean includeInterval);

}

Discussion

  • David Gilbert
    David Gilbert
    2013-08-02

    Thanks. This is committed for the upcoming 1.0.16 release (and merged to JFreeChart FSE).

     
  • David Gilbert
    David Gilbert
    2013-08-02

    • status: open --> closed-accepted
    • assigned_to: David Gilbert