public class

StyleMapDefaultImpl

extends AbstractStyleCatalogElement
implements StyleMapClause StyleMapDefault
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.transform.AbstractStyleCatalogElement
       ↳ com.microstrategy.web.transform.StyleMapDefaultImpl

Class Overview

This class represents a "default" clause in a Style Map.

Summary

Constants
String ATTR_NAME_MAPDEFAULT_TO_STYLE The name of the map default "to style" attribute.
String ELEM_NAME_MAPDEFAULT The name of the map default element.
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
From interface com.microstrategy.web.transform.StyleMapClause
Public Constructors
StyleMapDefaultImpl()
Public Methods
String getToStyle()
Returns the style to map to.
int getType()
Returns the type of the clause.
StyleMapperResult mapStyle(String fromStyle, StyleRequestContext context)
Maps the specified style to a new style based on the data in the StyleRequestContext object as well as any additional data specified on the condition.
void setToStyle(String toStyle)
Sets the style to map to.
Protected Methods
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.
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.web.transform.AbstractStyleCatalogElement
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
From interface com.microstrategy.web.transform.StyleMapClause

Constants

public static final String ATTR_NAME_MAPDEFAULT_TO_STYLE

The name of the map default "to style" attribute.

Constant Value: "to_style"

public static final String ELEM_NAME_MAPDEFAULT

The name of the map default element.

Constant Value: "MapDefault"

Public Constructors

public StyleMapDefaultImpl ()

Public Methods

public String getToStyle ()

Returns the style to map to.

Returns
  • The style to map to.

public int getType ()

Returns the type of the clause.

Returns
  • The type of the clause.

public StyleMapperResult mapStyle (String fromStyle, StyleRequestContext context)

Maps the specified style to a new style based on the data in the StyleRequestContext object as well as any additional data specified on the condition.

Parameters
fromStyle The style that is being requested.
context The data in the current style's request context.
Returns

public void setToStyle (String toStyle)

Sets the style to map to.

Parameters
toStyle The style to map to.

Protected Methods

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.

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.