Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

cern::gp::beans::BeanTagger Class Reference

List of all members.

Static Public Member Functions

void setCacheable (FeatureDescriptor featureDescriptor, boolean cacheable)
Boolean isCacheable (FeatureDescriptor featureDescriptor)
void setExpandable (FeatureDescriptor featureDescriptor, boolean expandable)
boolean isExpandable (FeatureDescriptor featureDescriptor)
void setDefaultAction (FeatureDescriptor featureDescriptor, String defaultAction)
void setDefaultAction (BeanInfo beanInfo, String defaultAction)
String getDefaultAction (FeatureDescriptor featureDescriptor)
String getDefaultAction (BeanInfo beanInfo)
void addActions (FeatureDescriptor featureDescriptor, String[] actions)
String[] getActions (FeatureDescriptor featureDescriptor)
String[] getActions (BeanInfo beanInfo)
void addActions (BeanInfo beanInfo, String[] actions)

Private Member Functions

 BeanTagger ()

Static Private Member Functions

final boolean getBooleanValue (FeatureDescriptor featureDescriptor, String property)
final void setBooleanValue (FeatureDescriptor featureDescriptor, String property, boolean value)
final boolean doesActionExist (String[] actions, String action)

Static Private Attributes

final String IS_CACHEABLE_PROPERTY_NAME = "beantagger.isCacheable"
final String IS_EXPANDABLE_PROPERTY_NAME = "beantagger.isExpandable"
final String ACTIONS_PROPERTY_NAME = "beantagger.actions"
final String DEFAULT_ACTION_PROPERTY_NAME = "beantagger.defaultAction"
final String EMPTY_STRING = ""

Detailed Description

Utility class that can tag a Property or a BeanInfo to add information to it. The available static methods describe what information it is possible to add.

Version:
Revision
1.2
Date
2006/09/25 08:52:36
Author:
Lionel Mestre


Constructor & Destructor Documentation

cern::gp::beans::BeanTagger::BeanTagger  )  [inline, private]
 

prevent the creation of an new instance


Member Function Documentation

void cern::gp::beans::BeanTagger::addActions BeanInfo  beanInfo,
String[]  actions
[inline, static]
 

Adds classes of available actions to this BeanInfo. If the BeanInfo already defines some actions the existing ones and the new ones are merged together.

Parameters:
actionClasses an array of the class of available action(s)

void cern::gp::beans::BeanTagger::addActions FeatureDescriptor  featureDescriptor,
String[]  actions
[inline, static]
 

Adds classes of available actions to this descriptor. If the featureDescriptor already defines some actions the existing ones and the new ones are merged together.

Parameters:
actionClasses an array of the class of available action(s)

final boolean cern::gp::beans::BeanTagger::doesActionExist String[]  actions,
String  action
[inline, static, private]
 

String [] cern::gp::beans::BeanTagger::getActions BeanInfo  beanInfo  )  [inline, static]
 

Gets the class of available actions for this BeanInfo

Returns:
an array of class of available actions for this BeanInfo

String [] cern::gp::beans::BeanTagger::getActions FeatureDescriptor  featureDescriptor  )  [inline, static]
 

Gets the class of available actions for this descriptor

Returns:
an array of class of available actions for this descriptor

final boolean cern::gp::beans::BeanTagger::getBooleanValue FeatureDescriptor  featureDescriptor,
String  property
[inline, static, private]
 

String cern::gp::beans::BeanTagger::getDefaultAction BeanInfo  beanInfo  )  [inline, static]
 

Gets the default action qualified name for this BeanInfo

Parameters:
beanInfo the BeanInfo to get the default action from
Returns:
the qualified name of the default action or null is not specified

String cern::gp::beans::BeanTagger::getDefaultAction FeatureDescriptor  featureDescriptor  )  [inline, static]
 

Gets the default action qualified name for this FeatureDescriptor

Parameters:
featureDescriptor the FeatureDescriptor to get the default action from
Returns:
the qualified name of the default action or null is not specified

Boolean cern::gp::beans::BeanTagger::isCacheable FeatureDescriptor  featureDescriptor  )  [inline, static]
 

Checks if the given FeatureDescriptor is cacheable

Returns:
true if and only if this FeatureDescriptor is cacheable.

boolean cern::gp::beans::BeanTagger::isExpandable FeatureDescriptor  featureDescriptor  )  [inline, static]
 

Checks if this FeatureDescriptor is expandable which neams that it can be expanded into a list of more FeatureDescriptors

Returns:
true if and only if this FeatureDescriptor is expandable.

final void cern::gp::beans::BeanTagger::setBooleanValue FeatureDescriptor  featureDescriptor,
String  property,
boolean  value
[inline, static, private]
 

void cern::gp::beans::BeanTagger::setCacheable FeatureDescriptor  featureDescriptor,
boolean  cacheable
[inline, static]
 

Adds the information that this FeatureDescriptor is cacheable which neams that its value(s) can be cached. If it is a PropertyDescriptor it means that the value of the property can be cached. If it is a BeanDescriptor it means that all property values can be cached

Parameters:
featureDescriptor the FeatureDescriptor to tag as expandable.
cacheable whether the value(s) of the FeatureDescriptor can be cached or not

void cern::gp::beans::BeanTagger::setDefaultAction BeanInfo  beanInfo,
String  defaultAction
[inline, static]
 

Sets the default action qualified name for this BeanInfo

Parameters:
beanInfo the BeanInfo to tag with the default action.
defaultAction the qualified name of the default action

void cern::gp::beans::BeanTagger::setDefaultAction FeatureDescriptor  featureDescriptor,
String  defaultAction
[inline, static]
 

Sets the default action qualified name for this FeatureDescriptor

Parameters:
featureDescriptor the FeatureDescriptor to tag with the default action
defaultAction the qualified name of the default action

void cern::gp::beans::BeanTagger::setExpandable FeatureDescriptor  featureDescriptor,
boolean  expandable
[inline, static]
 

Adds the information that this FeatureDescriptor is expandable which neams that it can be expanded into a list of more FeatureDescriptors

Parameters:
featureDescriptor the FeatureDescriptor to tag as expandable.
expandable whether the FeatureDescriptor is expandable or not


Member Data Documentation

final String cern::gp::beans::BeanTagger::ACTIONS_PROPERTY_NAME = "beantagger.actions" [static, private]
 

name of property that is used to specify the qname of available actions

final String cern::gp::beans::BeanTagger::DEFAULT_ACTION_PROPERTY_NAME = "beantagger.defaultAction" [static, private]
 

name of property that is used to specify the qname of the default action

final String cern::gp::beans::BeanTagger::EMPTY_STRING = "" [static, private]
 

final String cern::gp::beans::BeanTagger::IS_CACHEABLE_PROPERTY_NAME = "beantagger.isCacheable" [static, private]
 

name of property that can be used to specify that a property or a bean is cacheable which neams that the property value or all properties values of the bean can be cached

final String cern::gp::beans::BeanTagger::IS_EXPANDABLE_PROPERTY_NAME = "beantagger.isExpandable" [static, private]
 

name of property that can be used to specify that a property is expandable which neams that the property value is a bean having more properties


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:08:15 2009 for ACS Java API by doxygen 1.3.8