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