Package com.microstrategy.web.transform

Class MapperDefnImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.transform.AbstractStyleCatalogElement

com.microstrategy.web.transform.MapperDefnImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, MapperDefn, java.lang.Cloneable

public class MapperDefnImpl
extends AbstractStyleCatalogElement
implements MapperDefn

This class implements the MapperDefn interface for the Style Catalog.

Since:

MicroStrategy Web 9.0.0

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	ATTR_NAME_MAPPERDEFN_CLASS	This is the name of the mapper definition class attribute.
static java.lang.String	ATTR_NAME_MAPPERDEFN_DESCRIPTION	This is the name of the mapper definition description attribute.
static java.lang.String	ATTR_NAME_MAPPERDEFN_NAME	This is the name of the mapper definition name attribute.
static java.lang.String	ELEM_NAME_MAPPERDEFN	This is the name of the mapper definition element.

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
MapperDefnImpl()

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.
java.lang.String	getDescription()	Returns the description associated with this Mapper definition.
java.lang.String	getImplClassName()	Gets the fully qualified class name for the mapper definition.
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 this mapper object.
StyleMapper	getStyleMapperInstance()	Returns a new instance of a StyleMapper object from the associated information.
void	setDescription(java.lang.String description)	Sets the description associated with this Mapper definition.
void	setImplClassName(java.lang.String fqcn)	Sets the fully qualified class name for the mapper definition.
void	setName(java.lang.String name)	Sets the name of this mapper object.

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

ELEM_NAME_MAPPERDEFN

public static final java.lang.String ELEM_NAME_MAPPERDEFN

This is the name of the mapper definition element.

See Also:

Constant Field Values

ATTR_NAME_MAPPERDEFN_NAME

public static final java.lang.String ATTR_NAME_MAPPERDEFN_NAME

This is the name of the mapper definition name attribute.

See Also:

Constant Field Values

ATTR_NAME_MAPPERDEFN_CLASS

public static final java.lang.String ATTR_NAME_MAPPERDEFN_CLASS

This is the name of the mapper definition class attribute.

See Also:

Constant Field Values

ATTR_NAME_MAPPERDEFN_DESCRIPTION

public static final java.lang.String ATTR_NAME_MAPPERDEFN_DESCRIPTION

This is the name of the mapper definition description attribute.

See Also:

Constant Field Values

Constructor Detail

MapperDefnImpl

public MapperDefnImpl()

Method Detail

getName

public java.lang.String getName()

Returns the name of this mapper object.

Specified by:

getName in interface MapperDefn

Returns:

The name of this mapper object.

setName

public void setName(java.lang.String name)
             throws java.lang.IllegalArgumentException

Sets the name of this mapper object.

Specified by:

setName in interface MapperDefn

Parameters:

name - The name of this mapper object.

Throws:

java.lang.IllegalArgumentException - If the name is already used, then this exception is thrown.

getImplClassName

public java.lang.String getImplClassName()

Gets the fully qualified class name for the mapper definition.

Specified by:

getImplClassName in interface MapperDefn

Returns:

The fully qualified class name for the layout source.

setImplClassName

public void setImplClassName(java.lang.String fqcn)

Sets the fully qualified class name for the mapper definition.

Specified by:

setImplClassName in interface MapperDefn

Parameters:

fqcn - The fully qualified class name.

getDescription

public java.lang.String getDescription()

Returns the description associated with this Mapper definition.

Specified by:

getDescription in interface MapperDefn

Returns:

The description associated with this Mapper definition.

setDescription

public void setDescription(java.lang.String description)

Sets the description associated with this Mapper definition.

Specified by:

setDescription in interface MapperDefn

Parameters:

description - A description for this Mapper definition.

getStyleMapperInstance

public StyleMapper getStyleMapperInstance()

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

Specified by:

getStyleMapperInstance in interface MapperDefn

Returns:

A new instance of a StyleMapper object.

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

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