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