public interface

LayoutSourceDefn

implements ConfigurationElement
com.microstrategy.web.transform.LayoutSourceDefn
Known Indirect Subclasses

Class Overview

The LayoutSourceDefn interface stores the definition of a LayoutSource by recording a unique name and a fully qualified class name. This interface also provides a method to get an instance of the specified source. Note that only a single instance of the source is given out--it must be thread safe and not store any instance data members.

Summary

Public Methods
abstract String getImplClassName()
Gets the fully qualified class name for the layout source.
abstract LayoutSource getLayoutSourceInstance()
Creates or returns an existing instance of the referred layout source.
abstract String getName()
Gets the name associated with this layout source.
abstract void setImplClassName(String fqcn)
Sets the fully qualified class name for the layout source.
abstract void setName(String name)
Sets the name of the layout source.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract String getImplClassName ()

Gets the fully qualified class name for the layout source.

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

public abstract LayoutSource getLayoutSourceInstance ()

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

Returns
  • An instance of the layout source object.

public abstract String getName ()

Gets the name associated with this layout source.

Returns
  • The name of the layout source.

public abstract void setImplClassName (String fqcn)

Sets the fully qualified class name for the layout source.

Parameters
fqcn The fully qualified class name.

public abstract 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 If the name is already used, then this exception is thrown.