cern.gp.beans.impl

Class IntrospectionBasedNodeUpdater

java.lang.Object

cern.gp.beans.impl.IntrospectionBasedNodeUpdater

All Implemented Interfaces:

GPBean, NodeUpdater

public abstract class IntrospectionBasedNodeUpdater
extends java.lang.Object
implements NodeUpdater

**For internal use only** Provides support for implementing a NodeUpdater based on introspection.

For beans that do not implement any interface we use the JavaBeans specification for doing the introspection of the properties we are interested in. Those properties should have at least an associated getter. The list of properties we look for is defined by the GPBean interface.

This NodeUpdater also supports the BeanInfo tagging done through the BeanTagger class. Tagging a BeanInfo allows to add information that is not directly supported by the BeanInfo. Three tags are recognized by BeanNode :

• BeanTagger.getActions() to get the actions for this node. By default no action is added.
• BeanTagger.getDefaultAction() to get the default action for this node. By default the Property action is used.
• BeanTagger.isCacheable() to get whether the value of the properties of the bean can be cached or not.

Author:

Lionel Mestre

Field Summary

Fields inherited from interface cern.gp.beans.GPBean

CLASS_PROPERTY_NAME, DISPLAYNAME_PROPERTY_DISPLAY_NAME, DISPLAYNAME_PROPERTY_NAME, NAME_PROPERTY_DISPLAY_NAME, NAME_PROPERTY_NAME, NODE_ACTIONS_PROPERTY_NAME, NODE_DEFAULT_ACTION_PROPERTY_NAME, NODE_ICON_PROPERTY_NAME, NODE_PROPERTIES_CACHEABLE_PROPERTY_NAME, PROPERTY_INFO_PROPERTY_NAME, SHORTDESCRIPTION_PROPERTY_DISPLAY_NAME, SHORTDESCRIPTION_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntrospectionBasedNodeUpdater(java.lang.Object bean) Creates a new GuiUpdaterIntrospector
protected	IntrospectionBasedNodeUpdater(java.lang.Object bean, java.beans.BeanInfo beanInfo) Creates a new GuiUpdaterIntrospector
protected	IntrospectionBasedNodeUpdater(java.lang.Object bean, java.beans.BeanInfo beanInfo, java.lang.Class targetClass) Creates a new GuiUpdaterIntrospector

Method Summary

Modifier and Type	Method and Description
protected abstract void	fireDisplayNameChange(java.lang.String newDisplayName)
protected abstract void	fireNameChange(java.lang.String newName)
protected abstract void	fireNodeDefaultActionChange(java.lang.String newDefaultAction)
protected abstract void	fireNodeIconChange(java.awt.Image newIcon)
protected abstract void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
protected abstract void	fireShortDescriptionChange(java.lang.String newShortDescription)
java.lang.String	getDisplayName() Returns the internal display name of the associated bean.
java.lang.String	getName() Returns the internal name of the associated bean.
java.lang.String[]	getNodeActions() Returns an array of qualified name of actions for the node representing the associated bean.
java.lang.String	getNodeDefaultAction() Returns the qualified name of the default action for the node representing the associated bean.
java.awt.Image	getNodeIcon() Returns the icon in 16x16 size used to display the node representing the associated bean.
java.lang.Boolean	getNodePropertiesCacheable() Returns true if the value of the properties can be cached in the node, false if they cannot or null if no behavior is specified.
PropertyInfo[]	getPropertyInfo() Returns an array of PropertyInfo specifying information on some properties.
java.lang.String	getShortDescription() Returns a short description of the associated bean (used in tooltip for instance).
protected boolean	hasRegisteredListener()
boolean	isPropertyHidden(java.beans.PropertyDescriptor propertyDescriptor) Returns whether or not the property having the given PropertyDescriptor is a property supported by this introspector that should automatically be hidden.
protected void	removePropertyChangeListener()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cern.gp.beans.impl.NodeUpdater

addNodeUpdaterListener, removeNodeUpdaterListener

Constructor Detail

IntrospectionBasedNodeUpdater

protected IntrospectionBasedNodeUpdater(java.lang.Object bean)
                                 throws java.beans.IntrospectionException

Creates a new GuiUpdaterIntrospector

Throws:

java.beans.IntrospectionException

IntrospectionBasedNodeUpdater

protected IntrospectionBasedNodeUpdater(java.lang.Object bean,
                                        java.beans.BeanInfo beanInfo)
                                 throws java.beans.IntrospectionException

Creates a new GuiUpdaterIntrospector

Throws:

java.beans.IntrospectionException

IntrospectionBasedNodeUpdater

protected IntrospectionBasedNodeUpdater(java.lang.Object bean,
                                        java.beans.BeanInfo beanInfo,
                                        java.lang.Class targetClass)
                                 throws java.beans.IntrospectionException

Creates a new GuiUpdaterIntrospector

Throws:

java.beans.IntrospectionException

Method Detail

isPropertyHidden

public boolean isPropertyHidden(java.beans.PropertyDescriptor propertyDescriptor)

Returns whether or not the property having the given PropertyDescriptor is a property supported by this introspector that should automatically be hidden. In the case the property is supported and should not be hidden, the PropertyDescriptor will be updated with the display name of the property.

Parameters:

propertyName - the property name to check

Returns:

true if the property is automatically hidden false else

getName

public java.lang.String getName()

Description copied from interface: GPBean

Returns the internal name of the associated bean. If null is returned a default name will be used.

• Property name : name
• Visibility : normal (visible in a property sheet)
• Default value (when null is returned from this method) : a unique name generated using BeanUtils. generateUniqueBeanName()

Specified by:

getName in interface GPBean

Returns:

the internal name of the associated bean or null.

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: GPBean

Returns the internal display name of the associated bean. If null is returned a default name will be used.

• Property name : displayName
• Visibility : normal (visible in a property sheet)
• Default value (when null is returned from this method) : if getName() is available it is used instead of getDisplayName(), else beanInfo.getBeanDescriptor().getDisplayName() is used

Specified by:

getDisplayName in interface GPBean

Returns:

the internal display name of the associated bean or null

getShortDescription

public java.lang.String getShortDescription()

Description copied from interface: GPBean

Returns a short description of the associated bean (used in tooltip for instance). If null is returned a default description will be used.

• Property name : shortDescription
• Visibility : normal (visible in a property sheet)
• Default value (when null is returned from this method) : beanInfo.getBeanDescriptor(). getShortDescription()

Specified by:

getShortDescription in interface GPBean

Returns:

a short description of the associated bean or null

getNodeIcon

public java.awt.Image getNodeIcon()

Description copied from interface: GPBean

Returns the icon in 16x16 size used to display the node representing the associated bean. If null is returned a default icon will be used.

• Property name : nodeIcon
• Visibility : hidden (not visible in a property sheet)
• Default value (when null is returned from this method) : beanInfo.getIcon()

Specified by:

getNodeIcon in interface GPBean

Returns:

the icon in 16x16 size used to display the node representing the associated bean or null

getNodeDefaultAction

public java.lang.String getNodeDefaultAction()

Description copied from interface: GPBean

Returns the qualified name of the default action for the node representing the associated bean. The default action is the one triggered when the user double-clic on the node. If null is returned a default default action will be used.

• Property name : nodeDefaultAction
• Visibility : hidden
• Default value (when null is returned from this method) : use the possible tagging of the BeanDescriptor of the BeanInfo : BeanTagger.getDefaultAction(beanInfo.getBeanDescriptor())

Specified by:

getNodeDefaultAction in interface GPBean

Returns:

the qualified name of the default action for the node or null representing the associated bean.

getNodeActions

public java.lang.String[] getNodeActions()

Description copied from interface: GPBean

Returns an array of qualified name of actions for the node representing the associated bean. Null can be used in the array to represent a separator.

• Property name : nodeActions
• Visibility : hidden (not visible in a property sheet)
• Default value (when null is returned from this method) : use the possible tagging of the BeanDescriptor of the BeanInfo : BeanTagger.getActions(beanInfo.getBeanDescriptor())

Specified by:

getNodeActions in interface GPBean

Returns:

an array of qualified name of actions for a node representing the bean.

getNodePropertiesCacheable

public java.lang.Boolean getNodePropertiesCacheable()

Description copied from interface: GPBean

Returns true if the value of the properties can be cached in the node, false if they cannot or null if no behavior is specified. The default behavior is not to cache the value of the properties.

If the value of a property is not cached, the getter method will be invoked whenever the node need to get the value of the property.

If the value of the property is cached, the getter method for the property will only be invoked once to read the value. Then, whenever the node need the value of the property it will used the cached one until a PropertyChangeEvent for the property (or for all properties) is fired.

Caching values can improve performance greatly but it adds one more responsibility on the developer who has to fire PropertyChangeEvent whenever the property values change.

This property gives the caching strategy for all properties. It is possible to override the bean level caching strategy at the property level by using the property information getPropertyInformation().

• Property name : nodePropertiesCacheable
• Visibility : hidden (not visible in a property sheet)
• Default value (when null is returned from this method) : use the possible tagging of the BeanDescriptor of the BeanInfo : BeanTagger.isCacheable(beanInfo.getBeanDescriptor())

Specified by:

getNodePropertiesCacheable in interface GPBean

Returns:

true is the value of the properties can be cached in the node, false else or null for default behavior

getPropertyInfo

public PropertyInfo[] getPropertyInfo()

Description copied from interface: GPBean

Returns an array of PropertyInfo specifying information on some properties.

Each PropertyInfo of this array defines information for one property of this bean. Defining a PropertyInfo for a given property is usefull when there is no explicit BeanInfo for the bean and when the property have non default characteristics such as, for instance, a specific PropertyEditor.

• Property name : propertyInfo
• Visibility : hidden (not visible in a property sheet)
• Default value (when null is returned from this method) : use PropertyDescriptors from BeanInfo

Specified by:

getPropertyInfo in interface GPBean

Returns:

true is the value of the properties can be cached in the node, false else or null for default behavior

firePropertyChange

protected abstract void firePropertyChange(java.lang.String propertyName,
                                           java.lang.Object oldValue,
                                           java.lang.Object newValue)

fireNameChange

protected abstract void fireNameChange(java.lang.String newName)

fireDisplayNameChange

protected abstract void fireDisplayNameChange(java.lang.String newDisplayName)

fireShortDescriptionChange

protected abstract void fireShortDescriptionChange(java.lang.String newShortDescription)

fireNodeDefaultActionChange

protected abstract void fireNodeDefaultActionChange(java.lang.String newDefaultAction)

fireNodeIconChange

protected abstract void fireNodeIconChange(java.awt.Image newIcon)

removePropertyChangeListener

protected final void removePropertyChangeListener()

hasRegisteredListener

protected final boolean hasRegisteredListener()