View Javadoc

1   /**
2    * This file Copyright (c) 2008-2010 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.content2bean.impl;
35  
36  import info.magnolia.content2bean.PropertyTypeDescriptor;
37  import info.magnolia.content2bean.TransformationState;
38  import info.magnolia.content2bean.TypeDescriptor;
39  import org.slf4j.Logger;
40  import org.slf4j.LoggerFactory;
41  
42  import java.lang.reflect.Method;
43  import java.util.Map;
44  import java.util.Map.Entry;
45  
46  /**
47   * A transformer which "hides" a collection node. Extend or pass the type and node name in the constructor.
48   *
49   * @author pbracher
50   * @version $Revision: 32667 $ ($Author: gjoseph $)
51   */
52  public class CollectionPropertyHidingTransformer extends Content2BeanTransformerImpl {
53  
54      private static Logger log = LoggerFactory.getLogger(CollectionPropertyHidingTransformer.class);
55  
56      protected String collectionName;
57  
58      protected TypeDescriptor type;
59  
60      protected PropertyTypeDescriptor propertyDescriptor;
61  
62      protected Method addMethod;
63  
64      protected TypeDescriptor propertyType;
65  
66      public CollectionPropertyHidingTransformer(Class<?> beanClass, String collectionName) {
67          this.collectionName = collectionName;
68          type =  getTypeMapping().getTypeDescriptor(beanClass);
69          propertyDescriptor = type.getPropertyTypeDescriptor(collectionName);
70          addMethod = propertyDescriptor.getAddMethod();
71          propertyType = propertyDescriptor.getCollectionEntryType();
72      }
73  
74      protected TypeDescriptor onResolveType(TransformationState state, TypeDescriptor resolvedType){
75          if(resolvedType == null){
76              // if we are transforming a child node which does not define
77              // the class to be used, return the type of the collection entries
78  
79              // if the parent type is of the handled type
80              // this is the case when we are transforming children nodes)
81              if(state.getLevel()>1 && state.getCurrentType().equals(type)){
82                  // make it the default
83                  // use property descriptor
84                  resolvedType = propertyType;
85              }
86          }
87          return resolvedType;
88      }
89  
90      public void setProperty(TransformationState state, PropertyTypeDescriptor descriptor, Map<String, Object> values) {
91          if(descriptor.getName().equals(collectionName)){
92              Object bean = state.getCurrentBean();
93  
94              for (Entry<String, Object> entry : values.entrySet()) {
95                  String key = entry.getKey();
96                  Object value = entry.getValue();
97  
98                  if(propertyType.getType().isInstance(value) ){
99                      try {
100                         if(propertyDescriptor.isCollection()){
101                             addMethod.invoke(bean, new Object[]{value});
102                         }
103                         else{
104                             addMethod.invoke(bean, new Object[]{key, value});
105                         }
106                     } catch (Exception e) {
107                         log.error("Can't call adder method " + propertyDescriptor.getAddMethod(), e);
108                     }
109                 }
110             }
111         }
112         else{
113             super.setProperty(state, descriptor, values);
114         }
115     }
116 }