org.eclipse.osbp.runtime.web.vaadin.common/src/org/eclipse/osbp/runtime/web/vaadin/common/data/DeepResolvingBeanItem.java - osbp/org.eclipse.osbp.runtime.web - Git at Google

 /*
  * Copyright 2000-2014 Vaadin Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License. You may obtain a copy of
  * the License at
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  * License for the specific language governing permissions and limitations under
  * the License.
  *
  *  Contributors:
  * 		Florian Pirchner - copied from vaadin and changed implementations to meet requirements
  */
 package org.eclipse.osbp.runtime.web.vaadin.common.data;

 import java.beans.BeanInfo;
 import java.beans.IntrospectionException;
 import java.beans.Introspector;
 import java.beans.PropertyDescriptor;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;

 import com.vaadin.data.Property;
 import com.vaadin.data.util.MethodPropertyDescriptor;
 import com.vaadin.data.util.NestedMethodProperty;
 import com.vaadin.data.util.PropertysetItem;
 import com.vaadin.data.util.VaadinPropertyDescriptor;

 // TODO: Auto-generated Javadoc
 /**
  * A wrapper class for adding the Item interface to any Java Bean. It allows to
  * access nested properties that are not visible in the bean item.
  *
  * @author Vaadin Ltd.
  * @param <BT>
  *            the generic type
  * @since 3.0
  */
 @SuppressWarnings("serial")
 public class DeepResolvingBeanItem<BT> extends PropertysetItem {

 	/**
 	 * The bean which this Item is based on.
 	 */
 	private final BT bean;

 	/**
 	 * <p>
 	 * Creates a new instance of <code>DeepResolvingBeanItem</code> and adds all properties
 	 * of a Java Bean to it. The properties are identified by their respective
 	 * bean names.
 	 *
 	 *
 	 * <p>
 	 * Note : This version only supports introspectable bean properties and
 	 * their getter and setter methods. Stand-alone <code>is</code> and
 	 * <code>are</code> methods are not supported.
 	 *
 	 *
 	 * @param bean
 	 *            the Java Bean to copy properties from.
 	 *
 	 */
 	@SuppressWarnings("unchecked")
 	public DeepResolvingBeanItem(BT bean) {
 		this(bean, getPropertyDescriptors((Class<BT>) bean.getClass()));
 	}

 	/**
 	 * <p>
 	 * Creates a new instance of <code>DeepResolvingBeanItem</code> using a pre-computed set
 	 * of properties. The properties are identified by their respective bean
 	 * names.
 	 *
 	 *
 	 * @param bean
 	 *            the Java Bean to copy properties from.
 	 * @param propertyDescriptors
 	 *            pre-computed property descriptors
 	 */
 	public DeepResolvingBeanItem(BT bean,
 			Map<String, VaadinPropertyDescriptor<BT>> propertyDescriptors) {

 		this.bean = bean;

 		for (VaadinPropertyDescriptor<BT> pd : propertyDescriptors.values()) {
 			addItemProperty(pd.getName(), pd.createProperty(bean));
 		}
 	}

 	/**
 	 * <p>
 	 * Creates a new instance of <code>DeepResolvingBeanItem</code> and adds all listed
 	 * properties of a Java Bean to it - in specified order. The properties are
 	 * identified by their respective bean names.
 	 *
 	 *
 	 * <p>
 	 * Note : This version only supports introspectable bean properties and
 	 * their getter and setter methods. Stand-alone <code>is</code> and
 	 * <code>are</code> methods are not supported.
 	 *
 	 *
 	 * @param bean
 	 *            the Java Bean to copy properties from.
 	 * @param propertyIds
 	 *            id of the property.
 	 */
 	@SuppressWarnings("unchecked")
 	public DeepResolvingBeanItem(BT bean, Collection<?> propertyIds) {

 		this.bean = bean;

 		// Create bean information
 		LinkedHashMap<String, VaadinPropertyDescriptor<BT>> pds = getPropertyDescriptors((Class<BT>) bean
 				.getClass());

 		// Add all the bean properties as MethodProperties to this Item
 		for (Object id : propertyIds) {
 			VaadinPropertyDescriptor<BT> pd = pds.get(id);
 			if (pd != null) {
 				addItemProperty(pd.getName(), pd.createProperty(bean));
 			}
 		}

 	}

 	/**
 	 * <p>
 	 * Creates a new instance of <code>DeepResolvingBeanItem</code> and adds all listed
 	 * properties of a Java Bean to it - in specified order. The properties are
 	 * identified by their respective bean names.
 	 *
 	 *
 	 * <p>
 	 * Note : This version only supports introspectable bean properties and
 	 * their getter and setter methods. Stand-alone <code>is</code> and
 	 * <code>are</code> methods are not supported.
 	 *
 	 *
 	 * @param bean
 	 *            the Java Bean to copy properties from.
 	 * @param propertyIds
 	 *            ids of the properties.
 	 */
 	public DeepResolvingBeanItem(BT bean, String... propertyIds) {
 		this(bean, Arrays.asList(propertyIds));
 	}

 	/**
 	 * <p>
 	 * Perform introspection on a Java Bean class to find its properties.
 	 *
 	 *
 	 * <p>
 	 * Note : This version only supports introspectable bean properties and
 	 * their getter and setter methods. Stand-alone <code>is</code> and
 	 * <code>are</code> methods are not supported.
 	 *
 	 * @param <BT>
 	 *            the generic type
 	 * @param beanClass
 	 *            the Java Bean class to get properties for.
 	 * @return an ordered map from property names to property descriptors
 	 */
 	public static <BT> LinkedHashMap<String, VaadinPropertyDescriptor<BT>> getPropertyDescriptors(
 			final Class<BT> beanClass) {
 		final LinkedHashMap<String, VaadinPropertyDescriptor<BT>> pdMap = new LinkedHashMap<String, VaadinPropertyDescriptor<BT>>();

 		// Try to introspect, if it fails, we just have an empty Item
 		try {
 			List<PropertyDescriptor> propertyDescriptors = getBeanPropertyDescriptor(beanClass);

 			// Add all the bean properties as MethodProperties to this Item
 			// later entries on the list overwrite earlier ones
 			for (PropertyDescriptor pd : propertyDescriptors) {
 				final Method getMethod = pd.getReadMethod();
 				if ((getMethod != null)
 						&& getMethod.getDeclaringClass() != Object.class) {
 					VaadinPropertyDescriptor<BT> vaadinPropertyDescriptor = new MethodPropertyDescriptor<BT>(
 							pd.getName(), pd.getPropertyType(),
 							pd.getReadMethod(), pd.getWriteMethod());
 					pdMap.put(pd.getName(), vaadinPropertyDescriptor);
 				}
 			}
 		} catch (final java.beans.IntrospectionException ignored) {
 		}

 		return pdMap;
 	}

 	/**
 	 * Returns the property descriptors of a class or an interface.
 	 *
 	 * For an interface, superinterfaces are also iterated as Introspector does
 	 * not take them into account (Oracle Java bug 4275879), but in that case,
 	 * both the setter and the getter for a property must be in the same
 	 * interface and should not be overridden in subinterfaces for the discovery
 	 * to work correctly.
 	 *
 	 * For interfaces, the iteration is depth first and the properties of
 	 * superinterfaces are returned before those of their subinterfaces.
 	 *
 	 * @param beanClass
 	 *            the bean class
 	 * @return the bean property descriptor
 	 * @throws IntrospectionException
 	 *             the introspection exception
 	 */
 	private static List<PropertyDescriptor> getBeanPropertyDescriptor(
 			final Class<?> beanClass) throws IntrospectionException {
 		// Oracle bug 4275879: Introspector does not consider superinterfaces of
 		// an interface
 		if (beanClass.isInterface()) {
 			List<PropertyDescriptor> propertyDescriptors = new ArrayList<PropertyDescriptor>();

 			for (Class<?> cls : beanClass.getInterfaces()) {
 				propertyDescriptors.addAll(getBeanPropertyDescriptor(cls));
 			}

 			BeanInfo info = Introspector.getBeanInfo(beanClass);
 			propertyDescriptors.addAll(Arrays.asList(info
 					.getPropertyDescriptors()));

 			return propertyDescriptors;
 		} else {
 			BeanInfo info = Introspector.getBeanInfo(beanClass);
 			return Arrays.asList(info.getPropertyDescriptors());
 		}
 	}

 	/**
 	 * Expands nested bean properties by replacing a top-level property with
 	 * some or all of its sub-properties. The expansion is not recursive.
 	 *
 	 * @param propertyId
 	 *            property id for the property whose sub-properties are to be
 	 *            expanded,
 	 * @param subPropertyIds
 	 *            sub-properties to expand, all sub-properties are expanded if
 	 *            not specified
 	 */
 	public void expandProperty(String propertyId, String... subPropertyIds) {
 		Set<String> subPropertySet = new HashSet<String>(
 				Arrays.asList(subPropertyIds));

 		if (0 == subPropertyIds.length) {
 			// Enumerate all sub-properties
 			Class<?> propertyType = getItemProperty(propertyId).getType();
 			Map<String, ?> pds = getPropertyDescriptors(propertyType);
 			subPropertySet.addAll(pds.keySet());
 		}

 		for (String subproperty : subPropertySet) {
 			String qualifiedPropertyId = propertyId + "." + subproperty;
 			addNestedProperty(qualifiedPropertyId);
 		}

 		removeItemProperty(propertyId);
 	}

 	/**
 	 * Adds a nested property to the item. The property must not exist in the
 	 * item already and must of form "field1.field2" where field2 is a field in
 	 * the object referenced to by field1. If an intermediate property returns
 	 * null, the property will return a null value
 	 *
 	 * @param nestedPropertyId
 	 *            property id to add.
 	 */
 	public void addNestedProperty(String nestedPropertyId) {
 		addItemProperty(nestedPropertyId, new NestedMethodProperty<Object>(
 				getBean(), nestedPropertyId));
 	}

 	/**
 	 * Gets the underlying JavaBean object.
 	 *
 	 * @return the bean object.
 	 */
 	public BT getBean() {
 		return bean;
 	}

 	/* (non-Javadoc)
 	 * @see com.vaadin.data.util.PropertysetItem#getItemProperty(java.lang.Object)
 	 */
 	@Override
 	public Property<?> getItemProperty(Object id) {
 		Property<?> result = super.getItemProperty(id);
 		if (result == null) {
 			// create a transient nested method property for filter issues
 			result = new NestedMethodProperty<Object>(getBean(), (String) id);
 		}

 		return result;
 	}

 }
	/*
	* Copyright 2000-2014 Vaadin Ltd.
	*
	* Licensed under the Apache License, Version 2.0 (the "License"); you may not
	* use this file except in compliance with the License. You may obtain a copy of
	* the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
	* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
	* License for the specific language governing permissions and limitations under
	* the License.
	*
	* Contributors:
	* Florian Pirchner - copied from vaadin and changed implementations to meet requirements
	*/
	package org.eclipse.osbp.runtime.web.vaadin.common.data;

	import java.beans.BeanInfo;
	import java.beans.IntrospectionException;
	import java.beans.Introspector;
	import java.beans.PropertyDescriptor;
	import java.lang.reflect.Method;
	import java.util.ArrayList;
	import java.util.Arrays;
	import java.util.Collection;
	import java.util.HashSet;
	import java.util.LinkedHashMap;
	import java.util.List;
	import java.util.Map;
	import java.util.Set;

	import com.vaadin.data.Property;
	import com.vaadin.data.util.MethodPropertyDescriptor;
	import com.vaadin.data.util.NestedMethodProperty;
	import com.vaadin.data.util.PropertysetItem;
	import com.vaadin.data.util.VaadinPropertyDescriptor;

	// TODO: Auto-generated Javadoc
	/**
	* A wrapper class for adding the Item interface to any Java Bean. It allows to
	* access nested properties that are not visible in the bean item.
	*
	* @author Vaadin Ltd.
	* @param <BT>
	* the generic type
	* @since 3.0
	*/
	@SuppressWarnings("serial")
	public class DeepResolvingBeanItem<BT> extends PropertysetItem {

	/**
	* The bean which this Item is based on.
	*/
	private final BT bean;

	/**
	* <p>
	* Creates a new instance of <code>DeepResolvingBeanItem</code> and adds all properties
	* of a Java Bean to it. The properties are identified by their respective
	* bean names.
	*
	*
	* <p>
	* Note : This version only supports introspectable bean properties and
	* their getter and setter methods. Stand-alone <code>is</code> and
	* <code>are</code> methods are not supported.
	*
	*
	* @param bean
	* the Java Bean to copy properties from.
	*
	*/
	@SuppressWarnings("unchecked")
	public DeepResolvingBeanItem(BT bean) {
	this(bean, getPropertyDescriptors((Class<BT>) bean.getClass()));
	}

	/**
	* <p>
	* Creates a new instance of <code>DeepResolvingBeanItem</code> using a pre-computed set
	* of properties. The properties are identified by their respective bean
	* names.
	*
	*
	* @param bean
	* the Java Bean to copy properties from.
	* @param propertyDescriptors
	* pre-computed property descriptors
	*/
	public DeepResolvingBeanItem(BT bean,
	Map<String, VaadinPropertyDescriptor<BT>> propertyDescriptors) {

	this.bean = bean;

	for (VaadinPropertyDescriptor<BT> pd : propertyDescriptors.values()) {
	addItemProperty(pd.getName(), pd.createProperty(bean));
	}
	}

	/**
	* <p>
	* Creates a new instance of <code>DeepResolvingBeanItem</code> and adds all listed
	* properties of a Java Bean to it - in specified order. The properties are
	* identified by their respective bean names.
	*
	*
	* <p>
	* Note : This version only supports introspectable bean properties and
	* their getter and setter methods. Stand-alone <code>is</code> and
	* <code>are</code> methods are not supported.
	*
	*
	* @param bean
	* the Java Bean to copy properties from.
	* @param propertyIds
	* id of the property.
	*/
	@SuppressWarnings("unchecked")
	public DeepResolvingBeanItem(BT bean, Collection<?> propertyIds) {

	this.bean = bean;

	// Create bean information
	LinkedHashMap<String, VaadinPropertyDescriptor<BT>> pds = getPropertyDescriptors((Class<BT>) bean
	.getClass());

	// Add all the bean properties as MethodProperties to this Item
	for (Object id : propertyIds) {
	VaadinPropertyDescriptor<BT> pd = pds.get(id);
	if (pd != null) {
	addItemProperty(pd.getName(), pd.createProperty(bean));
	}
	}

	}

	/**
	* <p>
	* Creates a new instance of <code>DeepResolvingBeanItem</code> and adds all listed
	* properties of a Java Bean to it - in specified order. The properties are
	* identified by their respective bean names.
	*
	*
	* <p>
	* Note : This version only supports introspectable bean properties and
	* their getter and setter methods. Stand-alone <code>is</code> and
	* <code>are</code> methods are not supported.
	*
	*
	* @param bean
	* the Java Bean to copy properties from.
	* @param propertyIds
	* ids of the properties.
	*/
	public DeepResolvingBeanItem(BT bean, String... propertyIds) {
	this(bean, Arrays.asList(propertyIds));
	}

	/**
	* <p>
	* Perform introspection on a Java Bean class to find its properties.
	*
	*
	* <p>
	* Note : This version only supports introspectable bean properties and
	* their getter and setter methods. Stand-alone <code>is</code> and
	* <code>are</code> methods are not supported.
	*
	* @param <BT>
	* the generic type
	* @param beanClass
	* the Java Bean class to get properties for.
	* @return an ordered map from property names to property descriptors
	*/
	public static <BT> LinkedHashMap<String, VaadinPropertyDescriptor<BT>> getPropertyDescriptors(
	final Class<BT> beanClass) {
	final LinkedHashMap<String, VaadinPropertyDescriptor<BT>> pdMap = new LinkedHashMap<String, VaadinPropertyDescriptor<BT>>();

	// Try to introspect, if it fails, we just have an empty Item
	try {
	List<PropertyDescriptor> propertyDescriptors = getBeanPropertyDescriptor(beanClass);

	// Add all the bean properties as MethodProperties to this Item
	// later entries on the list overwrite earlier ones
	for (PropertyDescriptor pd : propertyDescriptors) {
	final Method getMethod = pd.getReadMethod();
	if ((getMethod != null)
	&& getMethod.getDeclaringClass() != Object.class) {
	VaadinPropertyDescriptor<BT> vaadinPropertyDescriptor = new MethodPropertyDescriptor<BT>(
	pd.getName(), pd.getPropertyType(),
	pd.getReadMethod(), pd.getWriteMethod());
	pdMap.put(pd.getName(), vaadinPropertyDescriptor);
	}
	}
	} catch (final java.beans.IntrospectionException ignored) {
	}

	return pdMap;
	}

	/**
	* Returns the property descriptors of a class or an interface.
	*
	* For an interface, superinterfaces are also iterated as Introspector does
	* not take them into account (Oracle Java bug 4275879), but in that case,
	* both the setter and the getter for a property must be in the same
	* interface and should not be overridden in subinterfaces for the discovery
	* to work correctly.
	*
	* For interfaces, the iteration is depth first and the properties of
	* superinterfaces are returned before those of their subinterfaces.
	*
	* @param beanClass
	* the bean class
	* @return the bean property descriptor
	* @throws IntrospectionException
	* the introspection exception
	*/
	private static List<PropertyDescriptor> getBeanPropertyDescriptor(
	final Class<?> beanClass) throws IntrospectionException {
	// Oracle bug 4275879: Introspector does not consider superinterfaces of
	// an interface
	if (beanClass.isInterface()) {
	List<PropertyDescriptor> propertyDescriptors = new ArrayList<PropertyDescriptor>();

	for (Class<?> cls : beanClass.getInterfaces()) {
	propertyDescriptors.addAll(getBeanPropertyDescriptor(cls));
	}

	BeanInfo info = Introspector.getBeanInfo(beanClass);
	propertyDescriptors.addAll(Arrays.asList(info
	.getPropertyDescriptors()));

	return propertyDescriptors;
	} else {
	BeanInfo info = Introspector.getBeanInfo(beanClass);
	return Arrays.asList(info.getPropertyDescriptors());
	}
	}

	/**
	* Expands nested bean properties by replacing a top-level property with
	* some or all of its sub-properties. The expansion is not recursive.
	*
	* @param propertyId
	* property id for the property whose sub-properties are to be
	* expanded,
	* @param subPropertyIds
	* sub-properties to expand, all sub-properties are expanded if
	* not specified
	*/
	public void expandProperty(String propertyId, String... subPropertyIds) {
	Set<String> subPropertySet = new HashSet<String>(
	Arrays.asList(subPropertyIds));

	if (0 == subPropertyIds.length) {
	// Enumerate all sub-properties
	Class<?> propertyType = getItemProperty(propertyId).getType();
	Map<String, ?> pds = getPropertyDescriptors(propertyType);
	subPropertySet.addAll(pds.keySet());
	}

	for (String subproperty : subPropertySet) {
	String qualifiedPropertyId = propertyId + "." + subproperty;
	addNestedProperty(qualifiedPropertyId);
	}

	removeItemProperty(propertyId);
	}

	/**
	* Adds a nested property to the item. The property must not exist in the
	* item already and must of form "field1.field2" where field2 is a field in
	* the object referenced to by field1. If an intermediate property returns
	* null, the property will return a null value
	*
	* @param nestedPropertyId
	* property id to add.
	*/
	public void addNestedProperty(String nestedPropertyId) {
	addItemProperty(nestedPropertyId, new NestedMethodProperty<Object>(
	getBean(), nestedPropertyId));
	}

	/**
	* Gets the underlying JavaBean object.
	*
	* @return the bean object.
	*/
	public BT getBean() {
	return bean;
	}

	/* (non-Javadoc)
	* @see com.vaadin.data.util.PropertysetItem#getItemProperty(java.lang.Object)
	*/
	@Override
	public Property<?> getItemProperty(Object id) {
	Property<?> result = super.getItemProperty(id);
	if (result == null) {
	// create a transient nested method property for filter issues
	result = new NestedMethodProperty<Object>(getBean(), (String) id);
	}

	return result;
	}

	}