java/cewolf-1.0/src/main/java/de/laures/cewolf/ChartHolder.java
changeset 1 639991d0808a
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/java/cewolf-1.0/src/main/java/de/laures/cewolf/ChartHolder.java	Sat Feb 28 21:31:02 2009 +0100
     1.3 @@ -0,0 +1,56 @@
     1.4 +/* ================================================================
     1.5 + * Cewolf : Chart enabling Web Objects Framework
     1.6 + * ================================================================
     1.7 + *
     1.8 + * Project Info:  http://cewolf.sourceforge.net
     1.9 + * Project Lead:  Guido Laures (guido@laures.de);
    1.10 + *
    1.11 + * (C) Copyright 2002, by Guido Laures
    1.12 + *
    1.13 + * This library is free software; you can redistribute it and/or modify it under the terms
    1.14 + * of the GNU Lesser General Public License as published by the Free Software Foundation;
    1.15 + * either version 2.1 of the License, or (at your option) any later version.
    1.16 + *
    1.17 + * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
    1.18 + * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    1.19 + * See the GNU Lesser General Public License for more details.
    1.20 + *
    1.21 + * You should have received a copy of the GNU Lesser General Public License along with this
    1.22 + * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
    1.23 + * Boston, MA 02111-1307, USA.
    1.24 + */
    1.25 +
    1.26 +package de.laures.cewolf;
    1.27 +
    1.28 +/**
    1.29 + * An object of this type represents a full descritption of a chart.
    1.30 + * Therefore it is able to produce the chart and dataset object
    1.31 + * resulting out of this definition.
    1.32 + * @author  Guido Laures
    1.33 + */
    1.34 +public interface ChartHolder {
    1.35 +
    1.36 +	/**
    1.37 +	 * Returns a chart. The type of this object is dependant on the underlying
    1.38 +	 * chart implementation. As of this version of Cewolf it is of type
    1.39 +	 * org.jfree.chart.JFreeChart.
    1.40 +	 * @return the chart object for this definition
    1.41 +	 * @throws DatasetProduceException if there could be no data produced for
    1.42 +	 * the cahrt
    1.43 +	 * @throws ConfigurationException if there is something wrong in the
    1.44 +	 * Cewolf configuration
    1.45 +	 * @throws PostProcessingException if a post processor failed to 
    1.46 +	 * process the chart
    1.47 +	 */
    1.48 +    public Object getChart() throws DatasetProduceException, PostProcessingException, ChartValidationException;
    1.49 +    
    1.50 +	/**
    1.51 +	 * Returns the dataset produced when using this definition.The type of this object is dependant on the underlying
    1.52 +	 * chart implementation. As of this version of Cewolf it is of type
    1.53 +	 * org.jfree.data.Dataset.
    1.54 +	 * @return Object the dataset for this definition
    1.55 +	 * @throws DatasetProduceException if the dataset could not be produced
    1.56 +	 */
    1.57 +    public Object getDataset() throws DatasetProduceException;
    1.58 +    
    1.59 +}