1 /**
2 * This file Copyright (c) 2012-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.jcr.node2bean;
35
36 import info.magnolia.objectfactory.ComponentProvider;
37
38 import java.util.Map;
39 import java.util.Map.Entry;
40
41 import javax.jcr.Node;
42 import javax.jcr.NodeIterator;
43 import javax.jcr.PropertyIterator;
44 import javax.jcr.RepositoryException;
45
46 /**
47 * Contract for transformation from node to java beans.
48 */
49 public interface Node2BeanTransformer {
50 /**
51 * Create a state object to share the state between the processor and transformer.
52 */
53 TransformationState newState();
54
55 /**
56 * Resolves the class to use for the current node.
57 */
58 TypeDescriptor resolveType(TypeMapping typeMapping, TransformationState state, ComponentProvider componentProvider) throws ClassNotFoundException, RepositoryException;
59
60 /**
61 * Returns the children of the node to be transformed. Those are normally the direct children but might differ.
62 */
63 NodeIterator getChildren(Node node) throws RepositoryException;
64
65 default PropertyIterator getProperties(Node node) throws RepositoryException {
66 return node.getProperties();
67 }
68
69 /**
70 * Instantiates the bean.
71 */
72 Object newBeanInstance(TransformationState state, Map<String, Object> values, ComponentProvider componentProvider) throws Node2BeanException;
73
74 /**
75 * Called after all properties are set.
76 */
77 void initBean(TransformationState state, Map<String, Object> values) throws Node2BeanException;
78
79
80 /**
81 * Set this property on that bean. Allows excluding of properties.
82 */
83 void setProperty(TypeMapping typeMapping, TransformationState state, PropertyTypeDescriptor descriptor, Map<String, Object> values) throws RepositoryException;
84
85 /**
86 * Returns whether this transformer can consume the given value and assign it to the currently-processed bean.
87 *
88 * <p>This is used in conjunction with {@link Node2BeanProcessor} to help it report unknown properties
89 * (aka {@link info.magnolia.transformer.TransformationProblem TransformationProblems}).
90 *
91 * @return false by default, i.e. no reporting of unknown property problems.
92 */
93 default boolean canHandleValue(TypeMapping typeMapping, TransformationState state, PropertyTypeDescriptor descriptor, Entry<String, Object> value) {
94 return false;
95 }
96
97 /**
98 * Returns whether this transformer handles value claims, helping {@link Node2BeanProcessor} to report unknown bean properties.
99 *
100 * @return false by default; implementations must opt-in explicitly to use this feature,
101 * and implement {@link #canHandleValue(TypeMapping, TransformationState, PropertyTypeDescriptor, Entry)} accordingly.
102 */
103 default boolean supportsValueClaims() {
104 return false;
105 }
106
107 /**
108 * Transforms the simple basic jcr property value objects to more complex properties.
109 */
110 Object convertPropertyValue(Class<?> propertyType, Object value) throws Node2BeanException;
111 }