public class

LayoutParserDefnsImpl

extends AbstractStyleCatalogList
implements LayoutParserDefns
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractElementList
       ↳ com.microstrategy.web.transform.AbstractStyleCatalogList
         ↳ com.microstrategy.web.transform.LayoutParserDefnsImpl

Class Overview

The LayoutParserDefnsImpl class implements the LayoutParserDefns interface for the Style Catalog.

Summary

Constants
String ATT_GLOBAL_PARSER
String NODE_LAYOUT_PARSER_DEFNS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
LayoutParserDefnsImpl()
Public Methods
LayoutParserDefn getGlobalParserDefn()
Returns the "global" layout parser definition object associated with this Style Catalog.
String getGlobalParserName()
Returns the name of the global parser currently associated with this collection
LayoutParserDefn getLayoutParserDefn(String name)
Gets the LayoutParserDefn associated with a given name.
LayoutParserDefn getLayoutParserDefn(int index)
Gets the LayoutParserDefn associated with supplied index.
LayoutParserDefn newLayoutParserDefn(String layoutParserName)
Creates a new layout parser definition object with the supplied name.
void remove(int index)
Removes an element from the collection.
void remove(String name)
Removes an element from the collection
void setGlobalParserName(String value)
Sets the name of the global parser.
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.
Class getListClass()
Returns the Class items beloging to this list will be instance of.
String getListNodeName()
Returns the name of the node representing children of this list.
[Expand]
Inherited Methods
From class com.microstrategy.web.transform.AbstractStyleCatalogList
From class com.microstrategy.utils.config.AbstractElementList
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.LayoutParserDefns

Constants

protected static final String ATT_GLOBAL_PARSER

Constant Value: "global_parser"

protected static final String NODE_LAYOUT_PARSER_DEFNS

Constant Value: "LayoutParserDefns"

Public Constructors

public LayoutParserDefnsImpl ()

Public Methods

public LayoutParserDefn getGlobalParserDefn ()

Returns the "global" layout parser definition object associated with this Style Catalog. If there is only layout parser definition stored in this collection, then it becomes the global parser defintion, by default. If there are more than one, then one of them is designated as the "global" parser using the setGlobalParserName(String) method.

Returns
  • The global layout parser definition object.

public String getGlobalParserName ()

Returns the name of the global parser currently associated with this collection

public LayoutParserDefn getLayoutParserDefn (String name)

Gets the LayoutParserDefn associated with a given name.

Parameters
name The name of the layout parser definition object to return.
Returns
Throws
IllegalArgumentException

public LayoutParserDefn getLayoutParserDefn (int index)

Gets the LayoutParserDefn associated with supplied index. A valid index begins at 0 and continues to getCount() - 1.

Parameters
index The index of the LayoutParserDefn to return.
Returns
Throws
IndexOutOfBoundsException

public LayoutParserDefn newLayoutParserDefn (String layoutParserName)

Creates a new layout parser definition object with the supplied name.

Parameters
layoutParserName The name of the new LayoutParserDefn object to create.
Returns
  • The new layout parser definition object.
Throws
IllegalArgumentException
UnsupportedOperationException

public void remove (int index)

Removes an element from the collection.

Parameters
index The position within the valid elements of the element to remove.
Throws
IndexOutOfBoundsException
UnsupportedOperationException

public void remove (String name)

Removes an element from the collection

Parameters
name the key of the object to remove
Throws
IllegalArgumentException
UnsupportedOperationException

public void setGlobalParserName (String value)

Sets the name of the global parser. This is the one used by default if not parser definition is associated with a transform definition.

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 Class getListClass ()

Returns the Class items beloging to this list will be instance of.

protected String getListNodeName ()

Returns the name of the node representing children of this list.