001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * ---------------
028 * DomainInfo.java
029 * ---------------
030 * (C) Copyright 2000-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.data;
038
039/**
040 * An interface (optional) that can be implemented by a dataset to assist in
041 * determining the minimum and maximum values.  If not present, 
042 * {@link org.jfree.data.general.DatasetUtils} will iterate over all the 
043 * values in the dataset to get the bounds.
044 */
045public interface DomainInfo {
046
047    /**
048     * Returns the minimum x-value in the dataset.
049     *
050     * @param includeInterval  a flag that determines whether or not the
051     *                         x-interval is taken into account.
052     *
053     * @return The minimum value or {@code Double.NaN} if there are no 
054     *     values.
055     */
056    double getDomainLowerBound(boolean includeInterval);
057
058    /**
059     * Returns the maximum x-value in the dataset.
060     *
061     * @param includeInterval  a flag that determines whether or not the
062     *                         x-interval is taken into account.
063     *
064     * @return The maximum value or {@code Double.NaN} if there are no 
065     *     values.
066     */
067    double getDomainUpperBound(boolean includeInterval);
068
069    /**
070     * Returns the range of the values in this dataset's domain.
071     *
072     * @param includeInterval  a flag that determines whether or not the
073     *                         x-interval is taken into account.
074     *
075     * @return The range (or {@code null} if the dataset contains no
076     *     values).
077     */
078    Range getDomainBounds(boolean includeInterval);
079
080}