Package com.microstrategy.web.transform

Class LayoutParserDefnImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.transform.AbstractStyleCatalogElement

com.microstrategy.web.transform.LayoutParserDefnImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, LayoutParserDefn, java.lang.Cloneable

public class LayoutParserDefnImpl
extends AbstractStyleCatalogElement
implements LayoutParserDefn

The LayoutParserDefnImpl class implements the LayoutParserDefn interface in the Style Catalog.

Since:

MicroStrategy Web 8.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
protected static java.lang.String	ATT_CLASS
protected static java.lang.String	ATT_NAME
protected static java.lang.String	NODE_LAYOUT_PARSER_DEFN

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

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	getImplClassName()	Gets the fully qualified class name for the layout parser.
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.
LayoutParser	getLayoutParserInstance()	Creates or returns an existing instance of the referred layout parser.
java.lang.String	getName()	Gets the name associated with this layout parser.
void	setImplClassName(java.lang.String fqcn)	Sets the fully qualified class name for the layout parser.
void	setName(java.lang.String name)	Sets the name of the layout parser.

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_CLASS

protected static final java.lang.String ATT_CLASS

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

NODE_LAYOUT_PARSER_DEFN

protected static final java.lang.String NODE_LAYOUT_PARSER_DEFN

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

LayoutParserDefnImpl

public LayoutParserDefnImpl()

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: LayoutParserDefn

Gets the name associated with this layout parser.

Specified by:

getName in interface LayoutParserDefn

Returns:

The name of the layout parser.

setName

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

Description copied from interface: LayoutParserDefn

Sets the name of the layout parser. The name is used in other places where a layout parser is required.

Specified by:

setName in interface LayoutParserDefn

Parameters:

name - The name of the layout parser.

Throws:

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

getImplClassName

public java.lang.String getImplClassName()

Description copied from interface: LayoutParserDefn

Gets the fully qualified class name for the layout parser.

Specified by:

getImplClassName in interface LayoutParserDefn

Returns:

The fully qualified class name for the layout parser.

setImplClassName

public void setImplClassName(java.lang.String fqcn)

Description copied from interface: LayoutParserDefn

Sets the fully qualified class name for the layout parser.

Specified by:

setImplClassName in interface LayoutParserDefn

Parameters:

fqcn - The fully qualified class name.

getLayoutParserInstance

public LayoutParser getLayoutParserInstance()

Description copied from interface: LayoutParserDefn

Creates or returns an existing instance of the referred layout parser.

Specified by:

getLayoutParserInstance in interface LayoutParserDefn

Returns:

An instance of the layout parser 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

Since:

MicroStrategy Web 9.0.0