1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.poifs.property;
57   
58   import java.io.IOException;
59   
60   import java.util.*;
61   
62   import org.apache.poi.poifs.common.POIFSConstants;
63   import org.apache.poi.poifs.storage.ListManagedBlock;
64   
65   /**
66    * Factory for turning an array of RawDataBlock instances containing
67    * Proprty data into an array of proper Property objects.
68    *
69    * The array produced may be sparse, in that any portion of data that
70    * should correspond to a Property, but which does not map to a proper
71    * Property (i.e., a DirectoryProperty, DocumentProperty, or
72    * RootProperty) will get mapped to a null Property in the array.
73    *
74    * @author Marc Johnson (mjohnson at apache dot org)
75    */
76   
77   class PropertyFactory
78   {
79   
80       // no need for an accessible constructor
81       private PropertyFactory()
82       {
83       }
84   
85       /**
86        * Convert raw data blocks to an array of Property's
87        *
88        * @param blocks to be converted
89        *
90        * @return the converted List of Property objects. May contain
91        *         nulls, but will not be null
92        *
93        * @exception IOException if any of the blocks are empty
94        */
95   
96       static List convertToProperties(ListManagedBlock [] blocks)
97           throws IOException
98       {
99           List properties = new ArrayList();
100  
101          for (int j = 0; j < blocks.length; j++)
102          {
103              byte[] data           = blocks[ j ].getData();
104              int    property_count = data.length
105                                      / POIFSConstants.PROPERTY_SIZE;
106              int    offset         = 0;
107  
108              for (int k = 0; k < property_count; k++)
109              {
110                  switch (data[ offset + PropertyConstants.PROPERTY_TYPE_OFFSET ])
111                  {
112  
113                      case PropertyConstants.DIRECTORY_TYPE :
114                          properties
115                              .add(new DirectoryProperty(properties.size(),
116                                                         data, offset));
117                          break;
118  
119                      case PropertyConstants.DOCUMENT_TYPE :
120                          properties.add(new DocumentProperty(properties.size(),
121                                                              data, offset));
122                          break;
123  
124                      case PropertyConstants.ROOT_TYPE :
125                          properties.add(new RootProperty(properties.size(),
126                                                          data, offset));
127                          break;
128  
129                      default :
130                          properties.add(null);
131                          break;
132                  }
133                  offset += POIFSConstants.PROPERTY_SIZE;
134              }
135          }
136          return properties;
137      }
138  }   // end package scope class PropertyFactory
139  
140