public
interface
LayoutParserDefn
implements ConfigurationElement| com.microstrategy.web.transform.LayoutParserDefn |
 Known Indirect Subclasses
|
Class Overview
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.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract String |
getImplClassName()
Gets the fully qualified class name for the layout parser.
| ||||||||||
| abstract LayoutParser |
getLayoutParserInstance()
Creates or returns an existing instance of the referred
layout parser.
| ||||||||||
| abstract String |
getName()
Gets the name associated with this layout parser.
| ||||||||||
| abstract void |
setImplClassName(String fqcn)
Sets the fully qualified class name for the layout parser.
| ||||||||||
| abstract void |
setName(String name)
Sets the name of the layout parser.
| ||||||||||
|
[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 parser.
Returns
- The fully qualified class name for the layout parser.
public abstract LayoutParser getLayoutParserInstance ()
Creates or returns an existing instance of the referred layout parser.
Returns
- An instance of the layout parser object.
public abstract String getName ()
Gets the name associated with this layout parser.
Returns
- The name of the layout parser.
public abstract void setImplClassName (String fqcn)
Sets the fully qualified class name for the layout parser.
Parameters
| fqcn | The fully qualified class name. |
|---|
public abstract 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 | If the name is already used, then this exception is thrown. |
|---|