Package com.microstrategy.web.app

Class WebBeanStyle

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.app.WebBeanStyle

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class WebBeanStyle
extends AbstractConfigurationElement

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.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATT_NAME
static java.lang.String	ATT_PREFERENCE
static java.lang.String	ATT_TRANSFORM_CLASS
static java.lang.String	NODE_STYLE

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
WebBeanStyle()	Class constructor.
WebBeanStyle(java.lang.String name, java.lang.String transformClass)	Class constructor.
WebBeanStyle(org.w3c.dom.Node root)	Class constructor.

Method Summary

Modifier and Type	Method	Description
protected java.lang.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.
java.lang.String	getName()	Returns the name of the WebBeanStyle instance.
java.lang.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
java.lang.String	getTransformClass()	If not empty, provides the fully-qualified name of the transforms class to associate with the bean
void	setName(java.lang.String name)	Sets the name of the WebBeanStyle instance.
void	setPreferenceName(java.lang.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(java.lang.String transformClass)	Sets the fully-qualified name of the transforms class to associate with the bean.

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NODE_STYLE

public static final java.lang.String NODE_STYLE

See Also:

Constant Field Values

ATT_PREFERENCE

public static final java.lang.String ATT_PREFERENCE

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_TRANSFORM_CLASS

public static final java.lang.String ATT_TRANSFORM_CLASS

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_NAME

public static final java.lang.String ATT_NAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

WebBeanStyle

public WebBeanStyle()

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

WebBeanStyle

public WebBeanStyle(java.lang.String name,
                    java.lang.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

WebBeanStyle

public WebBeanStyle(org.w3c.dom.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.

Method Detail

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

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.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0

setName

public void setName(java.lang.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.

getName

public java.lang.String getName()

Returns the name of the WebBeanStyle instance.

See Also:

setName(java.lang.String)

setTransformClass

public void setTransformClass(java.lang.String transformClass)

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

See Also:

WebBeanStyle

getTransformClass

public java.lang.String getTransformClass()

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

See Also:

WebBeanStyle

setPropertyList

public void setPropertyList(WebBeanPropertyList propertyList)

Set the property list for the WebBeanStyle instance

Parameters:

propertyList - property list for this style

getPropertyList

public WebBeanPropertyList getPropertyList()

Get the property list for the WebBeanStyle instance

Returns:

property list for this style

setPreferenceName

public void setPreferenceName(java.lang.String preferenceName)

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

See Also:

WebBeanStyle

getPreferenceName

public java.lang.String getPreferenceName()

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

See Also:

WebBeanStyle