Package com.microstrategy.web.transform

Class StyleImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.transform.AbstractStyleCatalogElement

com.microstrategy.web.transform.StyleImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, Style, java.lang.Cloneable

public class StyleImpl
extends AbstractStyleCatalogElement
implements Style

This class implements the Style interface, which exposes information about a single style.

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
protected static java.lang.String	ATT_DESCRIPTION
protected static java.lang.String	ATT_NAME
protected static java.lang.String	ATT_TRANSFORM
protected 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
StyleImpl()

Method Summary

Modifier and Type	Method	Description
protected void	clearCaches()	This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.
ActualParameters	getActualParams()	Returns the Actual parameters associated with this style.
java.lang.String	getDescription()	Returns the description of the style object.
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.
Layouts	getLayouts()	Gets the collection of layouts associated with this style.
java.lang.String	getName()	Returns the name of the style object.
TransformDefn	getTransformDefn()	Returns the transform definition object associated with this style.
java.lang.String	getTransformName()	Returns the name of the transform definition associated with this style
boolean	isLayoutAware()	This method returns true if the underlying transform is "layout aware".
boolean	isResolved()	Returns whether all the required formal parameters of the transform have actual values associated with them.
boolean	isResolved(StyleRequestContext context)	Returns whether all the required formal parameters of the transform have actual values associated with them.
void	setDescription(java.lang.String desc)	Sets the description of the style object.
void	setName(java.lang.String _name)	Sets the name of the style.
void	setName(java.lang.String _name, boolean overwrite)	Sets the name of the style.
void	setTransformDefn(TransformDefn transformDefn)	Sets the transform definition object of the style.
void	setTransformName(java.lang.String value)	Associates a the transform definition with this style based on its name

Methods inherited from class com.microstrategy.web.transform.AbstractStyleCatalogElement

copyContents, getStyleCatalog, hasChanged, reload, resetChanged, setStrAttribute

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, 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, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

ATT_NAME

protected static final java.lang.String ATT_NAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_DESCRIPTION

protected static final java.lang.String ATT_DESCRIPTION

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_TRANSFORM

protected static final java.lang.String ATT_TRANSFORM

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

NODE_STYLE

protected static final java.lang.String NODE_STYLE

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

StyleImpl

public StyleImpl()

Since:

MicroStrategy Web 9.0.0

Method Detail

clearCaches

protected void clearCaches()

Description copied from class: AbstractStyleCatalogElement

This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.

Overrides:

clearCaches in class AbstractStyleCatalogElement

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Description copied from interface: Style

Returns the name of the style object.

Specified by:

getName in interface Style

Returns:

name of the style object.

setName

public void setName(java.lang.String _name)

Description copied from interface: Style

Sets the name of the style.

Specified by:

setName in interface Style

Parameters:

_name - the name of the style.

Since:

MicroStrategy Web 9.0.0

setName

public void setName(java.lang.String _name,
                    boolean overwrite)
             throws java.lang.IllegalArgumentException

Description copied from interface: Style

Sets the name of the style.

Specified by:

setName in interface Style

Parameters:

_name - the name of the style.

overwrite - whether an existing style with that name will be overwritten.

Throws:

java.lang.IllegalArgumentException - thrown if the name is invalid or if it already exists and overwrite is false.

getDescription

public java.lang.String getDescription()

Description copied from interface: Style

Returns the description of the style object.

Specified by:

getDescription in interface Style

Returns:

description of the style object.

setDescription

public void setDescription(java.lang.String desc)

Description copied from interface: Style

Sets the description of the style object.

Specified by:

setDescription in interface Style

Parameters:

desc - the description of the style object.

getTransformName

public java.lang.String getTransformName()

Description copied from interface: Style

Returns the name of the transform definition associated with this style

Specified by:

getTransformName in interface Style

Returns:

name of the transform defn.

Since:

MicroStrategy Web 9.0.0

setTransformName

public void setTransformName(java.lang.String value)

Description copied from interface: Style

Associates a the transform definition with this style based on its name

Specified by:

setTransformName in interface Style

Since:

MicroStrategy Web 9.0.0

getTransformDefn

public TransformDefn getTransformDefn()

Description copied from interface: Style

Returns the transform definition object associated with this style.

Specified by:

getTransformDefn in interface Style

Returns:

the TransformDefn object associated with the style.

setTransformDefn

public void setTransformDefn(TransformDefn transformDefn)
                      throws java.lang.IllegalArgumentException

Description copied from interface: Style

Sets the transform definition object of the style.

Specified by:

setTransformDefn in interface Style

Parameters:

transformDefn - the TransformDefn object to set.

Throws:

java.lang.IllegalArgumentException - thrown if the transform definition object is null.

getActualParams

public ActualParameters getActualParams()

Description copied from interface: Style

Returns the Actual parameters associated with this style.

Specified by:

getActualParams in interface Style

Returns:

the ActualParameters object associated with this style.

getLayouts

public Layouts getLayouts()

Description copied from interface: Style

Gets the collection of layouts associated with this style.

Specified by:

getLayouts in interface Style

Returns:

The Layouts collection.

Since:

MicroStrategy Web 8.0.0

isResolved

public boolean isResolved()

Description copied from interface: Style

Returns whether all the required formal parameters of the transform have actual values associated with them.

Specified by:

isResolved in interface Style

Returns:

whether the transform is resolved or not.

isResolved

public boolean isResolved(StyleRequestContext context)

Description copied from interface: Style

Returns whether all the required formal parameters of the transform have actual values associated with them. A style is resolved if there is at least one actual parameter whose value matches the type of a required formal parameter.

Specified by:

isResolved in interface Style

Parameters:

context - a StyleRequestContext object used to look up the dynamic actual parameter value.

Returns:

True if the style is resolved.

Since:

MicroStrategy Web 8.0.0

isLayoutAware

public boolean isLayoutAware()

Description copied from interface: Style

This method returns true if the underlying transform is "layout aware". This translates into saying whether the underlying Transform implements the LayoutTransform interface.

Specified by:

isLayoutAware in interface Style

Returns:

True if the underlying transform is layout aware.

Since:

MicroStrategy Web 8.0.0

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