Source for org.jfree.xml.util.SimpleObjectFactory

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class library for the Java(tm) platform
   3:  * ========================================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  * 
   7:  * Project Info:  http://www.jfree.org/jcommon/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  * 
  27:  * ------------------------
  28:  * SimpleObjectFactory.java
  29:  * ------------------------
  30:  * (C)opyright 2003-2005, by Thomas Morgner and Contributors.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: SimpleObjectFactory.java,v 1.3 2005/10/18 13:33:53 mungady Exp $
  36:  *
  37:  * Changes 
  38:  * -------
  39:  * 02-Dec-2003 : Initial version
  40:  *  
  41:  */
  42: 
  43: package org.jfree.xml.util;
  44: 
  45: import java.util.HashMap;
  46: 
  47: /**
  48:  * A simple object factory.
  49:  */
  50: public class SimpleObjectFactory implements ObjectFactory {
  51: 
  52:     /** The object mappings. */
  53:     private HashMap objectMappings;
  54:     
  55:     /** The manual object mappings. */
  56:     private HashMap manualMappings;
  57:     
  58:     /** The multiplex mappings. */
  59:     private HashMap multiplexMappings;
  60: 
  61:     /**
  62:      * Creates a new instance.
  63:      */
  64:     public SimpleObjectFactory() {
  65:         this.objectMappings = new HashMap();
  66:         this.manualMappings = new HashMap();
  67:         this.multiplexMappings = new HashMap();
  68:     }
  69: 
  70:     /**
  71:      * Adds a manual mapping.
  72:      * 
  73:      * @param mapping  the mapping.
  74:      */
  75:     public void addManualMapping(final ManualMappingDefinition mapping) {
  76:         this.manualMappings.put(mapping.getBaseClass(), mapping);
  77:     }
  78: 
  79:     /**
  80:      * Adds a generic handler.
  81:      * 
  82:      * @param handler  the handler.
  83:      */
  84:     public void addGenericHandler(final GenericObjectFactory handler) {
  85:         this.objectMappings.put(handler.getBaseClass(), handler);
  86:     }
  87: 
  88:     /**
  89:      * Adds a multiplex mapping.
  90:      * 
  91:      * @param mplex  the multiplex mapping.
  92:      */
  93:     public void addMultiplexMapping(final MultiplexMappingDefinition mplex) {
  94:         this.multiplexMappings.put(mplex.getBaseClass(), mplex);
  95:     }
  96: 
  97:     /**
  98:      * Clears the mappings.
  99:      */
 100:     public void clear() {
 101:         this.objectMappings.clear();
 102:         this.manualMappings.clear();
 103:         this.multiplexMappings.clear();
 104:     }
 105: 
 106:     /**
 107:      * Returns a factory instance for the given class. The factory is independent
 108:      * from all previously generated instances.
 109:      *
 110:      * @param c the class
 111:      * @return the object factory.
 112:      */
 113:     public GenericObjectFactory getFactoryForClass(final Class c) {
 114:         final GenericObjectFactory factory = (GenericObjectFactory) this.objectMappings.get(c);
 115:         if (factory == null) {
 116:             return null;
 117:         }
 118:         return factory.getInstance();
 119:     }
 120: 
 121:     /**
 122:      * Returns the manual mapping definition for the given class, or null, if
 123:      * not manual definition exists.
 124:      *
 125:      * @param c the class for which to check the existence of the definition
 126:      * @return the manual mapping definition or null.
 127:      */
 128:     public ManualMappingDefinition getManualMappingDefinition(final Class c) {
 129:         return (ManualMappingDefinition) this.manualMappings.get(c);
 130:     }
 131: 
 132:     /**
 133:      * Returns the multiplex definition for the given class, or null, if no
 134:      * such definition exists.
 135:      *
 136:      * @param c the class for which to check the existence of the multiplexer
 137:      * @return the multiplexer for the class, or null if no multiplexer exists.
 138:      */
 139:     public MultiplexMappingDefinition getMultiplexDefinition(final Class c) {
 140:         final MultiplexMappingDefinition definition = (MultiplexMappingDefinition)
 141:         this.multiplexMappings.get(c);
 142:         return definition;
 143:     }
 144: 
 145:     /**
 146:      * Checks, whether a generic handler exists for the given class. This does
 147:      * not check, whether an mapping exists.
 148:      *
 149:      * @param c the class for which to check
 150:      * @return true, if an generic handler is defined, false otherwise.
 151:      */
 152:     public boolean isGenericHandler(final Class c) {
 153:         return this.objectMappings.containsKey(c);
 154:     }
 155: }