1 /**
2 * This file Copyright (c) 2003-2014 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;
35
36 import info.magnolia.cms.core.ItemType;
37
38 import java.beans.PropertyDescriptor;
39 import java.util.Collections;
40 import java.util.HashMap;
41 import java.util.Map;
42
43 import org.apache.commons.beanutils.PropertyUtils;
44
45
46 /**
47 * Describes the type under the transformation. Can be used to customize the output of the transformation.
48 *
49 * @deprecated since 4.5.18 - use {@link info.magnolia.jcr.node2bean.TypeDescriptor} instead.
50 */
51 public class TypeDescriptor {
52
53 private Class<?> type;
54
55 private ItemType itemType;
56
57 private Content2BeanTransformer transformer;
58
59 private boolean isMap;
60
61 private boolean isCollection;
62
63 private Map<String, PropertyTypeDescriptor> descriptors;
64
65 public ItemType getItemType() {
66 return this.itemType;
67 }
68
69 public void setItemType(ItemType itemType) {
70 this.itemType = itemType;
71 }
72
73 public Class<?> getType() {
74 return this.type;
75 }
76
77 public void setType(Class<?> type) {
78 this.type = type;
79 }
80
81
82 public boolean isCollection() {
83 return this.isCollection;
84 }
85
86
87 public void setCollection(boolean isCollection) {
88 this.isCollection = isCollection;
89 }
90
91
92 public boolean isMap() {
93 return this.isMap;
94 }
95
96
97 public void setMap(boolean isMap) {
98 this.isMap = isMap;
99 }
100
101 public PropertyTypeDescriptor getPropertyTypeDescriptor(String propertyName, TypeMapping typeMapping) {
102 return getPropertyDescriptors(typeMapping).get(propertyName);
103 }
104
105 /**
106 * @return true if this descriptor represents an map or collection, without a concrete type thereof.
107 */
108 public boolean needsDefaultMapping() {
109 return (isMap() || isCollection()) && (getType().isInterface() || getType().isArray());
110 }
111
112 /**
113 * This method is not synchronized to avoid thread blocking, but the method guarantees that the returned map is not mutated afterward.
114 */
115 public Map<String, PropertyTypeDescriptor> getPropertyDescriptors(TypeMapping typeMapping) {
116 //TODO ---- moved this out to TypeDescriptorFactory or something ?
117 if(this.descriptors == null){
118
119 // for not making this method synchronized we create a local variable first
120 // this guarantees that the map you get is not changed after return
121 final Map<String, PropertyTypeDescriptor> tmpDescriptors = new HashMap<String, PropertyTypeDescriptor>();
122 PropertyDescriptor[] dscrs = PropertyUtils.getPropertyDescriptors(this.getType());
123 for (int i = 0; i < dscrs.length; i++) {
124 PropertyDescriptor descriptor = dscrs[i];
125 tmpDescriptors.put(descriptor.getName(), typeMapping.getPropertyTypeDescriptor(this.getType(), descriptor.getName()));
126 }
127
128 this.descriptors = Collections.unmodifiableMap(tmpDescriptors);
129 }
130 return this.descriptors;
131 }
132
133 /**
134 * Can return a custom transformer. Otherwise null.
135 */
136 public Content2BeanTransformer getTransformer() {
137 return transformer;
138 }
139
140 public void setTransformer(Content2BeanTransformer transformer) {
141 this.transformer = transformer;
142 }
143
144 }