1 /**
2 * This file Copyright (c) 2008-2018 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 info.magnolia.content2bean.TypeMapping;
40 import info.magnolia.objectfactory.ComponentProvider;
41
42 import java.lang.reflect.Method;
43 import java.util.Map;
44 import java.util.Map.Entry;
45
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
48
49 /**
50 * A transformer which "hides" a collection node. Extend or pass the type and node name in the constructor.
51 *
52 * @deprecated since 5.2.4 - use {@link info.magnolia.jcr.node2bean.impl.CollectionPropertyHidingTransformer} instead.
53 */
54 public class CollectionPropertyHidingTransformer extends Content2BeanTransformerImpl {
55
56 private static Logger log = LoggerFactory.getLogger(CollectionPropertyHidingTransformer.class);
57
58 private final Class beanClass;
59 private final String collectionName;
60
61 private TypeDescriptor type;
62
63 private PropertyTypeDescriptor propertyDescriptor;
64
65 private Method addMethod;
66
67 private TypeDescriptor propertyType;
68
69 public CollectionPropertyHidingTransformer(Class<?> beanClass, String collectionName) {
70 super();
71 this.beanClass = beanClass;
72 this.collectionName = collectionName;
73
74 // TODO won't work since this.typeMapping is @Inject or passed, we don't have it yet.
75 // type = getTypeMapping().getTypeDescriptor(beanClass);
76 // propertyDescriptor = type.getPropertyTypeDescriptor(collectionName);
77 // addMethod = propertyDescriptor.getAddMethod();
78 // propertyType = propertyDescriptor.getCollectionEntryType();
79 }
80
81 @Override
82 protected TypeDescriptor onResolveType(TypeMapping typeMapping, TransformationState state, TypeDescriptor resolvedType, ComponentProvider componentProvider) {
83 // lazy init, we need TypeMapping
84 if (type == null) {
85 type = typeMapping.getTypeDescriptor(beanClass);
86 propertyDescriptor = type.getPropertyTypeDescriptor(collectionName, typeMapping);
87 addMethod = propertyDescriptor.getAddMethod();
88 propertyType = propertyDescriptor.getCollectionEntryType();
89 }
90
91 if (resolvedType == null) {
92 // if we are transforming a child node which does not define
93 // the class to be used, return the type of the collection entries
94
95 // if the parent type is of the handled type
96 // this is the case when we are transforming children nodes)
97 if (state.getLevel() > 1 && state.getCurrentType().equals(type)) {
98 // make it the default
99 // use property descriptor
100 resolvedType = propertyType;
101 }
102 }
103 return resolvedType;
104 }
105
106 @Override
107 public void setProperty(TypeMapping typeMapping, TransformationState state, PropertyTypeDescriptor descriptor, Map<String, Object> values) {
108 if (descriptor.getName().equals(collectionName)) {
109 Object bean = state.getCurrentBean();
110
111 for (Entry<String, Object> entry : values.entrySet()) {
112 String key = entry.getKey();
113 Object value = entry.getValue();
114
115 if (propertyType.getType().isInstance(value)) {
116 try {
117 if (propertyDescriptor.isCollection()) {
118 addMethod.invoke(bean, value);
119 } else {
120 addMethod.invoke(bean, key, value);
121 }
122 } catch (Exception e) {
123 log.error("Can't call adder method {}", propertyDescriptor.getAddMethod(), e);
124 }
125 }
126 }
127 } else {
128 super.setProperty(typeMapping, state, descriptor, values);
129 }
130 }
131 }