Package com.microstrategy.web.transform
Interface LayoutSourceDefn
-
- All Superinterfaces:
java.lang.Cloneable
,ConfigurationElement
- All Known Implementing Classes:
LayoutSourceDefnImpl
public interface LayoutSourceDefn extends ConfigurationElement
The LayoutSourceDefn interface stores the definition of aLayoutSource
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.- Since:
- MicroStrategy Web 8.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.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.java.lang.String
getName()
Gets the name associated with this layout source.void
setImplClassName(java.lang.String fqcn)
Sets the fully qualified class name for the layout source.void
setName(java.lang.String name)
Sets the name of the layout source.-
Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement
getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML
-
-
-
-
Method Detail
-
getName
java.lang.String getName()
Gets the name associated with this layout source.- Returns:
- The name of the layout source.
-
setName
void setName(java.lang.String name) throws java.lang.IllegalArgumentException
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:
java.lang.IllegalArgumentException
- If the name is already used, then this exception is thrown.
-
getImplClassName
java.lang.String getImplClassName()
Gets the fully qualified class name for the layout source.- Returns:
- The fully qualified class name for the layout source.
-
setImplClassName
void setImplClassName(java.lang.String fqcn)
Sets the fully qualified class name for the layout source.- Parameters:
fqcn
- The fully qualified class name.
-
getLayoutSourceInstance
LayoutSource getLayoutSourceInstance()
Creates or returns an existing instance of the referred layout source.- Returns:
- An instance of the layout source object.
-
-