public class

LayoutSourceDefnImpl

extends AbstractStyleCatalogElement
implements LayoutSourceDefn
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.transform.AbstractStyleCatalogElement
       ↳ com.microstrategy.web.transform.LayoutSourceDefnImpl

Class Overview

The LayoutSourceDefnImpl class implements the LayoutSourceDefn interface for the Style Catalog.

Summary

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

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_SOURCE_DEFN

Constant Value: "LayoutSourceDefn"

Public Constructors

public LayoutSourceDefnImpl ()

Public Methods

public String getImplClassName ()

Gets the fully qualified class name for the layout source.

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

public LayoutSource getLayoutSourceInstance ()

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

Returns
  • An instance of the layout source object.

public String getName ()

Gets the name associated with this layout source.

Returns
  • The name of the layout source.

public void setImplClassName (String fqcn)

Sets the fully qualified class name for the layout source.

Parameters
fqcn The fully qualified class name.

public void setName (String name)

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

Parameters
name The name of the layout source.
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.