Mercurial > projects > dwt2
view org.eclipse.core.databinding.beans/src/org/eclipse/core/databinding/beans/PojoObservables.d @ 104:88652073d1c2
More work on icu
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Sat, 02 May 2009 11:27:24 +0200 |
parents | 48d4ee626868 |
children |
line wrap: on
line source
/******************************************************************************* * Copyright (c) 2007, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation * Matthew Hall - bug 221704 *******************************************************************************/ module org.eclipse.core.databinding.beans.PojoObservables; import org.eclipse.core.databinding.beans.BeansObservables; import java.lang.all; import java.beans.PropertyChangeEvent; import java.beans.PropertyDescriptor; import org.eclipse.core.databinding.observable.IObservable; import org.eclipse.core.databinding.observable.Realm; import org.eclipse.core.databinding.observable.list.IObservableList; import org.eclipse.core.databinding.observable.map.IObservableMap; import org.eclipse.core.databinding.observable.masterdetail.IObservableFactory; import org.eclipse.core.databinding.observable.masterdetail.MasterDetailObservables; import org.eclipse.core.databinding.observable.set.IObservableSet; import org.eclipse.core.databinding.observable.value.IObservableValue; import org.eclipse.core.internal.databinding.beans.BeanObservableListDecorator; import org.eclipse.core.internal.databinding.beans.BeanObservableMapDecorator; import org.eclipse.core.internal.databinding.beans.BeanObservableSetDecorator; import org.eclipse.core.internal.databinding.beans.BeanObservableValueDecorator; import org.eclipse.core.internal.databinding.beans.JavaBeanObservableList; import org.eclipse.core.internal.databinding.beans.JavaBeanObservableMap; import org.eclipse.core.internal.databinding.beans.JavaBeanObservableSet; import org.eclipse.core.internal.databinding.beans.JavaBeanObservableValue; import org.eclipse.core.internal.databinding.beans.JavaBeanPropertyObservableMap; /** * A factory for creating observable objects for POJOs (plain old java objects) * that conform to idea of an object with getters and setters but does not * provide {@link PropertyChangeEvent property change events} on change. This * factory is identical to {@link BeansObservables} except for this fact. * * @since 1.1 */ final public class PojoObservables { /** * Returns an observable value in the default realm tracking the current * value of the named property of the given pojo. * * @param pojo * the object * @param propertyName * the name of the property * @return an observable value tracking the current value of the named * property of the given pojo */ public static IObservableValue observeValue(Object pojo, String propertyName) { return observeValue(Realm.getDefault(), pojo, propertyName); } /** * Returns an observable value in the given realm tracking the current value * of the named property of the given pojo. * * @param realm * the realm * @param pojo * the object * @param propertyName * the name of the property * @return an observable value tracking the current value of the named * property of the given pojo */ public static IObservableValue observeValue(Realm realm, Object pojo, String propertyName) { PropertyDescriptor descriptor = BeansObservables.getPropertyDescriptor( Class.fromObject(pojo), propertyName); return new JavaBeanObservableValue(realm, pojo, descriptor, false); } /** * Returns an observable map in the default realm tracking the current * values of the named property for the pojos in the given set. * * @param domain * the set of pojo objects * @param pojoClass * the common base type of pojo objects that may be in the set * @param propertyName * the name of the property * @return an observable map tracking the current values of the named * property for the pojos in the given domain set */ public static IObservableMap observeMap(IObservableSet domain, Class pojoClass, String propertyName) { PropertyDescriptor descriptor = BeansObservables.getPropertyDescriptor( pojoClass, propertyName); return new JavaBeanObservableMap(domain, descriptor, false); } /** * Returns an array of observable maps in the default realm tracking the * current values of the named propertys for the pojos in the given set. * * @param domain * the set of objects * @param pojoClass * the common base type of objects that may be in the set * @param propertyNames * the array of property names * @return an array of observable maps tracking the current values of the * named propertys for the pojos in the given domain set */ public static IObservableMap[] observeMaps(IObservableSet domain, Class pojoClass, String[] propertyNames) { IObservableMap[] result = new IObservableMap[propertyNames.length]; for (int i = 0; i < propertyNames.length; i++) { result[i] = observeMap(domain, pojoClass, propertyNames[i]); } return result; } /** * Returns an observable map in the given realm tracking the map-typed named * property of the given pojo object. * * @param realm * the realm * @param pojo * the pojo object * @param propertyName * the name of the property * @return an observable map tracking the map-typed named property of the * given pojo object */ public static IObservableMap observeMap(Realm realm, Object pojo, String propertyName) { PropertyDescriptor descriptor = BeansObservables.getPropertyDescriptor( Class.fromObject(pojo), propertyName); return new JavaBeanPropertyObservableMap(realm, pojo, descriptor, false); } /** * Returns an observable list in the given realm tracking the * collection-typed named property of the given pojo object. The returned * list is mutable. * * @param realm * the realm * @param pojo * the object * @param propertyName * the name of the collection-typed property * @return an observable list tracking the collection-typed named property * of the given pojo object * @see #observeList(Realm, Object, String, Class) */ public static IObservableList observeList(Realm realm, Object pojo, String propertyName) { return observeList(realm, pojo, propertyName, null); } /** * Returns an observable list in the given realm tracking the * collection-typed named property of the given bean object. The returned * list is mutable. When an item is added or removed the setter is invoked * for the list on the parent bean to provide notification to other * listeners via <code>PropertyChangeEvents</code>. This is done to * provide the same behavior as is expected from arrays as specified in the * bean spec in section 7.2. * * @param realm * the realm * @param pojo * the bean object * @param propertyName * the name of the property * @param elementType * type of the elements in the list. If <code>null</code> and * the property is an array the type will be inferred. If * <code>null</code> and the property type cannot be inferred * element type will be <code>null</code>. * @return an observable list tracking the collection-typed named property * of the given bean object */ public static IObservableList observeList(Realm realm, Object pojo, String propertyName, Class elementType) { PropertyDescriptor propertyDescriptor = BeansObservables .getPropertyDescriptor(Class.fromObject(pojo), propertyName); elementType = BeansObservables.getCollectionElementType(elementType, propertyDescriptor); return new JavaBeanObservableList(realm, pojo, propertyDescriptor, elementType, false); } /** * Returns an observable set in the given realm tracking the * collection-typed named property of the given pojo object. * * @param realm * the realm * @param pojo * the pojo object * @param propertyName * the name of the property * @return an observable set tracking the collection-typed named property of * the given pojo object */ public static IObservableSet observeSet(Realm realm, Object pojo, String propertyName) { return observeSet(realm, pojo, propertyName, null); } /** * @param realm * @param pojo * @param propertyName * @param elementType * can be <code>null</code> * @return an observable set that tracks the current value of the named * property for given pojo object */ public static IObservableSet observeSet(Realm realm, Object pojo, String propertyName, Class elementType) { PropertyDescriptor propertyDescriptor = BeansObservables .getPropertyDescriptor(Class.fromObject(pojo), propertyName); elementType = BeansObservables.getCollectionElementType(elementType, propertyDescriptor); return new JavaBeanObservableSet(realm, pojo, propertyDescriptor, elementType, false); } /** * Returns a factory for creating obervable values tracking the given * property of a particular pojo object * * @param realm * the realm to use * @param propertyName * the name of the property * @return an observable value factory */ public static IObservableFactory valueFactory(Realm realm, String propertyName) { return new class(realm, propertyName) IObservableFactory { Realm realm_; String propertyName_; this(Realm r, String p){ realm_=r; propertyName_=p; } public IObservable createObservable(Object target) { return observeValue(realm_, target, propertyName_); } }; } /** * Returns a factory for creating obervable lists tracking the given * property of a particular pojo object * * @param realm * the realm to use * @param propertyName * the name of the property * @param elementType * @return an observable list factory */ public static IObservableFactory listFactory(Realm realm, String propertyName, Class elementType) { return new class(realm, propertyName, elementType) IObservableFactory { Realm realm_; String propertyName_; Class elementType_; this(Realm r, String p, Class e){ realm_=r; propertyName_=p; elementType_=e; } public IObservable createObservable(Object target) { return observeList(realm_, target, propertyName_, elementType_); } }; } /** * Returns a factory for creating obervable sets tracking the given property * of a particular pojo object * * @param realm * the realm to use * @param propertyName * the name of the property * @return an observable set factory */ public static IObservableFactory setFactory(Realm realm, String propertyName) { return new class(realm, propertyName) IObservableFactory { Realm realm_; String propertyName_; this(Realm r, String p){ realm_=r; propertyName_=p; } public IObservable createObservable(Object target) { return observeSet(realm_, target, propertyName_); } }; } /** * @param realm * @param propertyName * @param elementType * can be <code>null</code> * @return an observable set factory for creating observable sets */ public static IObservableFactory setFactory(Realm realm, String propertyName, Class elementType) { return new class(realm, propertyName, elementType) IObservableFactory { Realm realm_; String propertyName_; Class elementType_; this(Realm r, String p, Class e){ realm_=r; propertyName_=p; elementType_=e; } public IObservable createObservable(Object target) { return observeSet(realm_, target, propertyName_, elementType_); } }; } /** * Returns a factory for creating an observable map. The factory, when * provided with a pojo object, will create an {@link IObservableMap} in the * given realm that tracks the map-typed named property for the specified * pojo. * * @param realm * the realm assigned to observables created by the returned * factory. * @param propertyName * the name of the property * @return a factory for creating {@link IObservableMap} objects. */ public static IObservableFactory mapPropertyFactory(Realm realm, String propertyName) { return new class(realm, propertyName) IObservableFactory { Realm realm_; String propertyName_; this(Realm r, String p){ realm_=r; propertyName_=p; } public IObservable createObservable(Object target) { return observeMap(realm_, target, propertyName_); } }; } /** * Helper method for * <code>MasterDetailObservables.detailValue(master, valueFactory(realm, propertyName), propertyType)</code> * * @param realm * @param master * @param propertyName * @param propertyType * can be <code>null</code> * @return an observable value that tracks the current value of the named * property for the current value of the master observable value * * @see MasterDetailObservables */ public static IObservableValue observeDetailValue(Realm realm, IObservableValue master, String propertyName, Class propertyType) { IObservableValue value = MasterDetailObservables.detailValue(master, valueFactory(realm, propertyName), propertyType); BeanObservableValueDecorator decorator = new BeanObservableValueDecorator( value, master, BeansObservables.getValueTypePropertyDescriptor( master, propertyName)); return decorator; } /** * Helper method for * <code>MasterDetailObservables.detailList(master, listFactory(realm, propertyName, propertyType), propertyType)</code> * * @param realm * @param master * @param propertyName * @param propertyType * can be <code>null</code> * @return an observable list that tracks the named property for the current * value of the master observable value * * @see MasterDetailObservables */ public static IObservableList observeDetailList(Realm realm, IObservableValue master, String propertyName, Class propertyType) { IObservableList observableList = MasterDetailObservables.detailList( master, listFactory(realm, propertyName, propertyType), propertyType); BeanObservableListDecorator decorator = new BeanObservableListDecorator( observableList, cast(Object)master, BeansObservables .getValueTypePropertyDescriptor(master, propertyName)); return decorator; } /** * Helper method for * <code>MasterDetailObservables.detailSet(master, setFactory(realm, propertyName), propertyType)</code> * * @param realm * @param master * @param propertyName * @param propertyType * can be <code>null</code> * @return an observable set that tracks the named property for the current * value of the master observable value * * @see MasterDetailObservables */ public static IObservableSet observeDetailSet(Realm realm, IObservableValue master, String propertyName, Class propertyType) { IObservableSet observableSet = MasterDetailObservables.detailSet( master, setFactory(realm, propertyName, propertyType), propertyType); BeanObservableSetDecorator decorator = new BeanObservableSetDecorator( observableSet, cast(Object)master, BeansObservables .getValueTypePropertyDescriptor(master, propertyName)); return decorator; } /** * Helper method for * <code>MasterDetailObservables.detailMap(master, mapFactory(realm, propertyName))</code> * * @param realm * @param master * @param propertyName * @return an observable map that tracks the map-type named property for the * current value of the master observable value. */ public static IObservableMap observeDetailMap(Realm realm, IObservableValue master, String propertyName) { IObservableMap observableMap = MasterDetailObservables.detailMap( master, mapPropertyFactory(realm, propertyName)); BeanObservableMapDecorator decorator = new BeanObservableMapDecorator( observableMap, cast(Object)master, BeansObservables .getValueTypePropertyDescriptor(master, propertyName)); return decorator; } }