Source for org.jfree.report.JFreeReportCoreModule

   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: JFreeReportCoreModule.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: 
  32: package org.jfree.report;
  33: 
  34: import java.io.InputStream;
  35: 
  36: import org.jfree.base.modules.AbstractModule;
  37: import org.jfree.base.modules.ModuleInitializeException;
  38: import org.jfree.base.modules.SubSystem;
  39: import org.jfree.util.ObjectUtilities;
  40: 
  41: 
  42: /**
  43:  * The CoreModule is used to represent the base classes of JFreeReport in a
  44:  * PackageManager-compatible way. Modules may request a certain core-version to be present
  45:  * by referencing to this module.
  46:  * <p>
  47:  * This module is used to initialize the image and drawable factories. If the
  48:  * Pixie library is available, support for WMF-files is added to the factories.
  49:  *
  50:  * @author Thomas Morgner
  51:  */
  52: public class JFreeReportCoreModule extends AbstractModule
  53: {
  54:   /**
  55:    * The 'no-printer-available' property key.
  56:    */
  57:   public static final String NO_PRINTER_AVAILABLE_KEY
  58:           = "org.jfree.report.NoPrinterAvailable";
  59: 
  60:   /**
  61:    * The G2 fontrenderer bug override configuration key.
  62:    */
  63:   public static final String FONTRENDERER_ISBUGGY_FRC_KEY
  64:           = "org.jfree.report.layout.fontrenderer.IsBuggyFRC";
  65: 
  66:   /**
  67:    * The text aliasing configuration key.
  68:    */
  69:   public static final String FONTRENDERER_USEALIASING_KEY
  70:           = "org.jfree.report.layout.fontrenderer.UseAliasing";
  71: 
  72:   /**
  73:    * A configuration key that defines, whether errors will abort the report
  74:    * processing. This defaults to true.
  75:    */
  76:   public static final String STRICT_ERROR_HANDLING_KEY
  77:           = "org.jfree.report.StrictErrorHandling";
  78:   /**
  79:    * Creates a new module definition based on the 'coremodule.properties' file of this
  80:    * package.
  81:    *
  82:    * @throws ModuleInitializeException if the file could not be loaded.
  83:    */
  84:   public JFreeReportCoreModule ()
  85:           throws ModuleInitializeException
  86:   {
  87:     final InputStream in = ObjectUtilities.getResourceRelativeAsStream
  88:             ("coremodule.properties", JFreeReportCoreModule.class);
  89:     if (in == null)
  90:     {
  91:       throw new ModuleInitializeException
  92:               ("File 'coremodule.properties' not found in JFreeReport package.");
  93:     }
  94:     loadModuleInfo(in);
  95:   }
  96: 
  97:   /**
  98:    * Initializes the module. Use this method to perform all initial setup operations. This
  99:    * method is called only once in a modules lifetime. If the initializing cannot be
 100:    * completed, throw a ModuleInitializeException to indicate the error,. The module will
 101:    * not be available to the system.
 102:    *
 103:    * @param subSystem the subSystem.
 104:    * @throws org.jfree.base.modules.ModuleInitializeException
 105:    *          if an error ocurred while initializing the module.
 106:    */
 107:   public void initialize (final SubSystem subSystem)
 108:           throws ModuleInitializeException
 109:   {
 110:   }
 111: }