public class

WebBeanStyle

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.app.WebBeanStyle

Class Overview

Associates a transform with a bean, and allows to change the values of formal-parameters based on the values specified in the child WebBeanProperty elements. There are 3 possibilities on how the transform is associated:

  1. if transform-class is specified, the given transform is associated with the bean.
  2. if preference is specified, the value of the preference must represent a valid name of a style from the Style Catalog. This style is then associated with the bean.
  3. otherwise, the name must represent a valid name of a style from the Style Catalog.

Summary

Constants
String ATT_NAME
String ATT_PREFERENCE
String ATT_TRANSFORM_CLASS
String NODE_STYLE
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
WebBeanStyle()
Class constructor.
WebBeanStyle(String name, String transformClass)
Class constructor.
WebBeanStyle(Node root)
Class constructor.
Public Methods
String getName()
Returns the name of the WebBeanStyle instance.
String getPreferenceName()
If not empty, provides the name of a preference whose value is the name of a style to use.
WebBeanPropertyList getPropertyList()
Get the property list for the WebBeanStyle instance
String getTransformClass()
If not empty, provides the fully-qualified name of the transforms class to associate with the bean
void setName(String name)
Sets the name of the WebBeanStyle instance.
void setPreferenceName(String preferenceName)
Sets the name of a preference whose value is the name of the style to use.
void setPropertyList(WebBeanPropertyList propertyList)
Set the property list for the WebBeanStyle instance
void setTransformClass(String transformClass)
Sets the fully-qualified name of the transforms class to associate with the bean.
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_PREFERENCE

Constant Value: "preference"

public static final String ATT_TRANSFORM_CLASS

Constant Value: "transform-class"

public static final String NODE_STYLE

Constant Value: "style"

Public Constructors

public WebBeanStyle ()

Class constructor. Initializes a new -empty- instance of the WebBeanStyle class.

public WebBeanStyle (String name, String transformClass)

Class constructor. Initializes a new instance of the WebBeanStyle with the values passed as parameters. One of these two parameters must exist. But both are not required.

Parameters
name style name
transformClass transform class name

public WebBeanStyle (Node root)

Class constructor. Initializes a WebBeanStyle instance based on the information included on the XML Node

Parameters
root Node instance representing the web bean style information.

Public Methods

public String getName ()

Returns the name of the WebBeanStyle instance.

See Also

public String getPreferenceName ()

If not empty, provides the name of a preference whose value is the name of a style to use.

See Also

public WebBeanPropertyList getPropertyList ()

Get the property list for the WebBeanStyle instance

Returns
  • property list for this style

public String getTransformClass ()

If not empty, provides the fully-qualified name of the transforms class to associate with the bean

See Also

public void setName (String name)

Sets the name of the WebBeanStyle instance. The name uniquely identifies this style. If transform-class or preference are not specified, this must represent a valid name of a style from the Style Catalog.

public void setPreferenceName (String preferenceName)

Sets the name of a preference whose value is the name of the style to use.

See Also

public void setPropertyList (WebBeanPropertyList propertyList)

Set the property list for the WebBeanStyle instance

Parameters
propertyList property list for this style

public void setTransformClass (String transformClass)

Sets the fully-qualified name of the transforms class to associate with the bean.

See Also

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.