java/cewolf-1.0/src/main/java/de/laures/cewolf/ChartHolder.java
author František Kučera <franta-hg@frantovo.cz>
Sat, 28 Feb 2009 21:31:02 +0100
changeset 1 639991d0808a
permissions -rw-r--r--
Rozbalená knihovna verze 1.0
franta-hg@1
     1
/* ================================================================
franta-hg@1
     2
 * Cewolf : Chart enabling Web Objects Framework
franta-hg@1
     3
 * ================================================================
franta-hg@1
     4
 *
franta-hg@1
     5
 * Project Info:  http://cewolf.sourceforge.net
franta-hg@1
     6
 * Project Lead:  Guido Laures (guido@laures.de);
franta-hg@1
     7
 *
franta-hg@1
     8
 * (C) Copyright 2002, by Guido Laures
franta-hg@1
     9
 *
franta-hg@1
    10
 * This library is free software; you can redistribute it and/or modify it under the terms
franta-hg@1
    11
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
franta-hg@1
    12
 * either version 2.1 of the License, or (at your option) any later version.
franta-hg@1
    13
 *
franta-hg@1
    14
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
franta-hg@1
    15
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
franta-hg@1
    16
 * See the GNU Lesser General Public License for more details.
franta-hg@1
    17
 *
franta-hg@1
    18
 * You should have received a copy of the GNU Lesser General Public License along with this
franta-hg@1
    19
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
franta-hg@1
    20
 * Boston, MA 02111-1307, USA.
franta-hg@1
    21
 */
franta-hg@1
    22
franta-hg@1
    23
package de.laures.cewolf;
franta-hg@1
    24
franta-hg@1
    25
/**
franta-hg@1
    26
 * An object of this type represents a full descritption of a chart.
franta-hg@1
    27
 * Therefore it is able to produce the chart and dataset object
franta-hg@1
    28
 * resulting out of this definition.
franta-hg@1
    29
 * @author  Guido Laures
franta-hg@1
    30
 */
franta-hg@1
    31
public interface ChartHolder {
franta-hg@1
    32
franta-hg@1
    33
	/**
franta-hg@1
    34
	 * Returns a chart. The type of this object is dependant on the underlying
franta-hg@1
    35
	 * chart implementation. As of this version of Cewolf it is of type
franta-hg@1
    36
	 * org.jfree.chart.JFreeChart.
franta-hg@1
    37
	 * @return the chart object for this definition
franta-hg@1
    38
	 * @throws DatasetProduceException if there could be no data produced for
franta-hg@1
    39
	 * the cahrt
franta-hg@1
    40
	 * @throws ConfigurationException if there is something wrong in the
franta-hg@1
    41
	 * Cewolf configuration
franta-hg@1
    42
	 * @throws PostProcessingException if a post processor failed to 
franta-hg@1
    43
	 * process the chart
franta-hg@1
    44
	 */
franta-hg@1
    45
    public Object getChart() throws DatasetProduceException, PostProcessingException, ChartValidationException;
franta-hg@1
    46
    
franta-hg@1
    47
	/**
franta-hg@1
    48
	 * Returns the dataset produced when using this definition.The type of this object is dependant on the underlying
franta-hg@1
    49
	 * chart implementation. As of this version of Cewolf it is of type
franta-hg@1
    50
	 * org.jfree.data.Dataset.
franta-hg@1
    51
	 * @return Object the dataset for this definition
franta-hg@1
    52
	 * @throws DatasetProduceException if the dataset could not be produced
franta-hg@1
    53
	 */
franta-hg@1
    54
    public Object getDataset() throws DatasetProduceException;
franta-hg@1
    55
    
franta-hg@1
    56
}