1    /* ====================================================================
2     * The Apache Software License, Version 1.1
3     *
4     * Copyright (c) 2002 The Apache Software Foundation.  All rights
5     * reserved.
6     *
7     * Redistribution and use in source and binary forms, with or without
8     * modification, are permitted provided that the following conditions
9     * are met:
10    *
11    * 1. Redistributions of source code must retain the above copyright
12    *    notice, this list of conditions and the following disclaimer.
13    *
14    * 2. Redistributions in binary form must reproduce the above copyright
15    *    notice, this list of conditions and the following disclaimer in
16    *    the documentation and/or other materials provided with the
17    *    distribution.
18    *
19    * 3. The end-user documentation included with the redistribution,
20    *    if any, must include the following acknowledgment:
21    *       "This product includes software developed by the
22    *        Apache Software Foundation (http://www.apache.org/)."
23    *    Alternately, this acknowledgment may appear in the software itself,
24    *    if and wherever such third-party acknowledgments normally appear.
25    *
26    * 4. The names "Apache" and "Apache Software Foundation" and
27    *    "Apache POI" must not be used to endorse or promote products
28    *    derived from this software without prior written permission. For
29    *    written permission, please contact apache@apache.org.
30    *
31    * 5. Products derived from this software may not be called "Apache",
32    *    "Apache POI", nor may "Apache" appear in their name, without
33    *    prior written permission of the Apache Software Foundation.
34    *
35    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46    * SUCH DAMAGE.
47    * ====================================================================
48    *
49    * This software consists of voluntary contributions made by many
50    * individuals on behalf of the Apache Software Foundation.  For more
51    * information on the Apache Software Foundation, please see
52    * <http://www.apache.org/>.
53    */
54   package org.apache.poi.hssf.eventmodel;
55   
56   import java.io.InputStream;
57   import java.util.ArrayList;
58   import java.util.Iterator;
59   import java.util.List;
60   
61   import org.apache.poi.hssf.model.Model;
62   import org.apache.poi.hssf.model.Sheet;
63   import org.apache.poi.hssf.model.Workbook;
64   import org.apache.poi.hssf.record.BOFRecord;
65   import org.apache.poi.hssf.record.EOFRecord;
66   import org.apache.poi.hssf.record.Record;
67   
68   
69   /**
70    * ModelFactory creates workbook and sheet models based upon 
71    * events thrown by them there events from the EventRecordFactory.
72    * 
73    * @see org.apache.poi.hssf.eventmodel.EventRecordFactory
74    * @author Andrew C. Oliver acoliver@apache.org
75    */
76   public class ModelFactory implements ERFListener
77   {
78   
79       List listeners;
80       Model currentmodel;
81       boolean lastEOF;
82    
83       /**
84        * Constructor for ModelFactory.  Does practically nothing.
85        */
86       public ModelFactory()
87       {
88           super();
89           listeners = new ArrayList(1);
90       }
91       
92       /**
93        * register a ModelFactoryListener so that it can receive 
94        * Models as they are created.
95        */
96       public void registerListener(ModelFactoryListener listener) {
97           listeners.add(listener);
98       }
99       
100      /**
101       * Start processing the Workbook stream into Model events.
102       */
103      public void run(InputStream stream) {
104          EventRecordFactory factory = new EventRecordFactory(true);
105          factory.registerListener(this,null);
106          lastEOF = true;
107          factory.processRecords(stream);
108      }
109  
110      //ERFListener
111      public boolean processRecord(Record rec)
112      {
113         if (rec.getSid() == BOFRecord.sid) {
114               if (lastEOF != true) {
115                throw new RuntimeException("Not yet handled embedded models");  
116               } else {
117                BOFRecord bof = (BOFRecord)rec;
118                switch (bof.getType()) {
119                 case BOFRecord.TYPE_WORKBOOK:
120                   currentmodel = new Workbook();                 
121                 break;
122                 case BOFRecord.TYPE_WORKSHEET:
123                   currentmodel = new Sheet();                                  
124                 break;
125                default:
126                     throw new RuntimeException("Unsupported model type "+bof.getType());
127                }                
128                 
129               }        
130          }
131          
132          if (rec.getSid() == EOFRecord.sid) {
133              lastEOF = true;
134              throwEvent(currentmodel);
135          } else {
136              lastEOF = false;   
137          }
138          
139   
140          return true;
141      }
142  
143      /**
144       * Throws the model as an event to the listeners
145       * @param model to be thrown
146       */
147      private void throwEvent(Model model)
148      {
149          Iterator i = listeners.iterator();
150          while (i.hasNext()) {
151            ModelFactoryListener mfl = (ModelFactoryListener) i.next();
152            mfl.process(model);
153          }
154      }
155  
156  
157  }
158