public class

LayoutParserDefnImpl

extends AbstractStyleCatalogElement
implements LayoutParserDefn
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.transform.AbstractStyleCatalogElement
       ↳ com.microstrategy.web.transform.LayoutParserDefnImpl

Class Overview

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

Summary

Constants
String ATT_CLASS
String ATT_NAME
String NODE_LAYOUT_PARSER_DEFN
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
LayoutParserDefnImpl()
Public Methods
String getImplClassName()
Gets the fully qualified class name for the layout parser.
LayoutParser getLayoutParserInstance()
Creates or returns an existing instance of the referred layout parser.
String getName()
Gets the name associated with this layout parser.
void setImplClassName(String fqcn)
Sets the fully qualified class name for the layout parser.
void setName(String name)
Sets the name of the layout parser.
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.LayoutParserDefn

Constants

protected static final String ATT_CLASS

Constant Value: "class"

protected static final String ATT_NAME

Constant Value: "name"

protected static final String NODE_LAYOUT_PARSER_DEFN

Constant Value: "LayoutParserDefn"

Public Constructors

public LayoutParserDefnImpl ()

Public Methods

public String getImplClassName ()

Gets the fully qualified class name for the layout parser.

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

public LayoutParser getLayoutParserInstance ()

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

Returns
  • An instance of the layout parser object.

public String getName ()

Gets the name associated with this layout parser.

Returns
  • The name of the layout parser.

public void setImplClassName (String fqcn)

Sets the fully qualified class name for the layout parser.

Parameters
fqcn The fully qualified class name.

public void setName (String name)

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

Parameters
name The name of the layout parser.
Throws
IllegalArgumentException

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.