1 /** 2 * This file Copyright (c) 2012-2016 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 40 import javax.jcr.Node; 41 import javax.jcr.NodeIterator; 42 import javax.jcr.RepositoryException; 43 44 /** 45 * Contract for transformation from node to java beans. 46 */ 47 public interface Node2BeanTransformer { 48 /** 49 * Create a state object to share the state between the processor and transformer. 50 */ 51 public TransformationState newState(); 52 53 /** 54 * Resolves the class to use for the current node. 55 */ 56 public TypeDescriptor resolveType(TypeMapping typeMapping, TransformationState state, ComponentProvider componentProvider) throws ClassNotFoundException, RepositoryException; 57 58 /** 59 * Returns the children of the node to be transformed. Those are normally the direct children but might differ. 60 */ 61 public NodeIterator getChildren(Node node) throws RepositoryException; 62 63 /** 64 * Instantiates the bean. 65 */ 66 public Object newBeanInstance(TransformationState state, Map<String, Object> values, ComponentProvider componentProvider) throws Node2BeanException; 67 68 /** 69 * Called after all properties are set. 70 */ 71 public void initBean(TransformationState state, Map<String, Object> values) throws Node2BeanException; 72 73 74 /** 75 * Set this property on that bean. Allows excluding of properties. 76 */ 77 public void setProperty(TypeMapping typeMapping, TransformationState state, PropertyTypeDescriptor descriptor, Map<String, Object> values) throws RepositoryException; 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 Node2BeanException; 83 84 }