Source for org.jfree.report.ReportDataFactory

   1: /**
   2:  * ========================================
   3:  * JFreeReport : a free Java report library
   4:  * ========================================
   5:  *
   6:  * Project Info:  http://reporting.pentaho.org/
   7:  *
   8:  * (C) Copyright 2000-2007, by Object Refinery Limited, Pentaho Corporation and Contributors.
   9:  *
  10:  * This library is free software; you can redistribute it and/or modify it under the terms
  11:  * of the GNU Lesser General Public License as published by the Free Software Foundation;
  12:  * either version 2.1 of the License, or (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
  15:  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16:  * See the GNU Lesser General Public License for more details.
  17:  *
  18:  * You should have received a copy of the GNU Lesser General Public License along with this
  19:  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20:  * Boston, MA 02111-1307, USA.
  21:  *
  22:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
  23:  * in the United States and other countries.]
  24:  *
  25:  * ------------
  26:  * $Id: ReportDataFactory.java 2725 2007-04-01 18:49:29Z taqua $
  27:  * ------------
  28:  * (C) Copyright 2000-2005, by Object Refinery Limited.
  29:  * (C) Copyright 2005-2007, by Pentaho Corporation.
  30:  */
  31: package org.jfree.report;
  32: 
  33: /**
  34:  * The report data-factory is responsible for querying the data from arbitary
  35:  * datasources.
  36:  *
  37:  * @author Thomas Morgner
  38:  */
  39: public interface ReportDataFactory
  40: {
  41:   public void open();
  42: 
  43:   /**
  44:    * Queries a datasource. The string 'query' defines the name of the query.
  45:    * The Parameterset given here may contain more data than actually needed.
  46:    *
  47:    * The dataset may change between two calls, do not assume anything!
  48:    *
  49:    * @param query
  50:    * @param parameters
  51:    * @return
  52:    */
  53:   public ReportData queryData (final String query, final DataSet parameters)
  54:           throws ReportDataFactoryException;
  55: 
  56:   /**
  57:    * Closes the report data factory and all report data instances that have
  58:    * been returned by this instance.
  59:    */
  60:   public void close();
  61: 
  62:   /**
  63:    * Derives a freshly initialized report data factory, which is independend
  64:    * of the original data factory. Opening or Closing one data factory must not
  65:    * affect the other factories.
  66:    *
  67:    * @return
  68:    */
  69:   public ReportDataFactory derive ();
  70: }