1 /**
2 * This file Copyright (c) 2003-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;
35
36 import info.magnolia.cms.core.Content;
37 import info.magnolia.objectfactory.Components;
38
39 import java.util.Collection;
40 import java.util.Map;
41
42
43 /**
44 * Used to create beans
45 * @author philipp
46 * @version $Id: Content2BeanTransformer.java 32667 2010-03-13 00:37:06Z gjoseph $
47 */
48 public interface Content2BeanTransformer {
49 /**
50 * Create a state object to share the state between the processor and transformer
51 */
52 public TransformationState newState();
53
54 /**
55 * Resolves the class to use for the current node
56 */
57 public TypeDescriptor resolveType(TransformationState state) throws ClassNotFoundException;
58
59 /**
60 * Returns the children of the node to be transformed. Those are normally the direct children but might differ
61 */
62 public Collection<Content> getChildren(Content node);
63
64 /**
65 * Instantiates the bean
66 */
67 public Object newBeanInstance(TransformationState state, Map values) throws Content2BeanException;
68
69 /**
70 * Called after all properties are set
71 */
72 public void initBean(TransformationState state, Map values) throws Content2BeanException;
73
74 /**
75 * Set this property on that bean. Allows excluding of properties
76 */
77 public void setProperty(TransformationState state, PropertyTypeDescriptor descriptor, Map<String, Object> values);
78
79 /**
80 * Transforms the simple basic jcr property value objects to more complex properties
81 */
82 public Object convertPropertyValue(Class<?> propertyType, Object value) throws Content2BeanException;
83
84 /**
85 * The mapping to use
86 */
87 public TypeMapping getTypeMapping();
88
89 /**
90 * Get your instance here
91 */
92 class Factory {
93 public static Content2BeanTransformer getDefaultTransformer() {
94 return Components.getSingleton(Content2BeanTransformer.class);
95 }
96 }
97
98
99 }