public class

MapperDefnImpl

extends AbstractStyleCatalogElement
implements MapperDefn
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.transform.AbstractStyleCatalogElement
       ↳ com.microstrategy.web.transform.MapperDefnImpl

Class Overview

This class implements the MapperDefn interface for the Style Catalog.

Summary

Constants
String ATTR_NAME_MAPPERDEFN_CLASS This is the name of the mapper definition class attribute.
String ATTR_NAME_MAPPERDEFN_DESCRIPTION This is the name of the mapper definition description attribute.
String ATTR_NAME_MAPPERDEFN_NAME This is the name of the mapper definition name attribute.
String ELEM_NAME_MAPPERDEFN This is the name of the mapper definition element.
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
MapperDefnImpl()
Public Methods
String getDescription()
Returns the description associated with this Mapper definition.
String getImplClassName()
Gets the fully qualified class name for the mapper definition.
String getName()
Returns the name of this mapper object.
StyleMapper getStyleMapperInstance()
Returns a new instance of a StyleMapper object from the associated information.
void setDescription(String description)
Sets the description associated with this Mapper definition.
void setImplClassName(String fqcn)
Sets the fully qualified class name for the mapper definition.
void setName(String name)
Sets the name of this mapper object.
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.MapperDefn

Constants

public static final String ATTR_NAME_MAPPERDEFN_CLASS

This is the name of the mapper definition class attribute.

Constant Value: "class"

public static final String ATTR_NAME_MAPPERDEFN_DESCRIPTION

This is the name of the mapper definition description attribute.

Constant Value: "description"

public static final String ATTR_NAME_MAPPERDEFN_NAME

This is the name of the mapper definition name attribute.

Constant Value: "name"

public static final String ELEM_NAME_MAPPERDEFN

This is the name of the mapper definition element.

Constant Value: "MapperDefn"

Public Constructors

public MapperDefnImpl ()

Public Methods

public String getDescription ()

Returns the description associated with this Mapper definition.

Returns
  • The description associated with this Mapper definition.

public String getImplClassName ()

Gets the fully qualified class name for the mapper definition.

Returns
  • The fully qualified class name for the layout source.

public String getName ()

Returns the name of this mapper object.

Returns
  • The name of this mapper object.

public StyleMapper getStyleMapperInstance ()

Returns a new instance of a StyleMapper object from the associated information.

Returns

public void setDescription (String description)

Sets the description associated with this Mapper definition.

Parameters
description A description for this Mapper definition.

public void setImplClassName (String fqcn)

Sets the fully qualified class name for the mapper definition.

Parameters
fqcn The fully qualified class name.

public void setName (String name)

Sets the name of this mapper object.

Parameters
name The name of this mapper object.
Throws
IllegalArgumentException If the name is already used, then this exception is thrown.

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.