LayoutParserDefn (Web API 2021)

All Superinterfaces:

java.lang.Cloneable, ConfigurationElement

All Known Implementing Classes:

LayoutParserDefnImpl
```
public interface LayoutParserDefn
extends ConfigurationElement
```
The LayoutParserDefn interface stores the definition of a LayoutParser by recording a unique name and a fully qualified class name. This interface also provides a method to get an instance of the specified parser. Note that only a single instance of the parser 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 parser.
`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 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 parser.
    
    Returns:
    
    The name of the layout parser.
  - setName
```
void setName(java.lang.String name)
      throws java.lang.IllegalArgumentException
```
    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:
    
    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 parser.
    
    Returns:
    
    The fully qualified class name for the layout parser.
  - setImplClassName
```
void setImplClassName(java.lang.String fqcn)
```
    Sets the fully qualified class name for the layout parser.
    
    Parameters:
    
    fqcn - The fully qualified class name.
  - getLayoutParserInstance
```
LayoutParser getLayoutParserInstance()
```
    Creates or returns an existing instance of the referred layout parser.
    
    Returns:
    
    An instance of the layout parser object.