public interface

LayoutParserDefns

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

Class Overview

The LayoutParserDefns interface represents a collection of layout parser defined by this Style Catalog. This is a standard collection interface that includes a method to return the "global" layout parser.

Summary

Public Methods
abstract void clear()
Clears the collection of layout parser definition objects.
abstract int getCount()
Returns the number of LayoutParserDefn objects in this collection.
abstract LayoutParserDefn getGlobalParserDefn()
Returns the "global" layout parser definition object associated with this Style Catalog.
abstract String getGlobalParserName()
Returns the name of the global parser currently associated with this collection
abstract LayoutParserDefn getLayoutParserDefn(String name)
Gets the LayoutParserDefn associated with a given name.
abstract LayoutParserDefn getLayoutParserDefn(int index)
Gets the LayoutParserDefn associated with supplied index.
abstract LayoutParserDefn newLayoutParserDefn(String layoutParserName)
Creates a new layout parser definition object with the supplied name.
abstract void remove(int index)
Removes the LayoutParserDefn object at the specified index.
abstract void remove(String name)
Removes the LayoutParserDefn object at the specified index.
abstract void setGlobalParserName(String value)
Sets the name of the global parser.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract void clear ()

Clears the collection of layout parser definition objects.

Throws
UnsupportedOperationException This exception is thrown if the Style Catalog is in "read only" mode.

public abstract int getCount ()

Returns the number of LayoutParserDefn objects in this collection.

Returns
  • The count of layout parser definition objects.

public abstract 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 abstract String getGlobalParserName ()

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

public abstract 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 This exception is thrown if the argument does not match one of the stored names.

public abstract 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 This exception is thown if the argument is outside the range of a valid index.

public abstract 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 This exception is thrown if the argument already matches one of the stored names.
UnsupportedOperationException This exception is thrown if the Style Catalog is in "read only" mode.

public abstract void remove (int index)

Removes the LayoutParserDefn object at the specified index.

Parameters
index The index of the layout parser definition object to remove.
Throws
IndexOutOfBoundsException This exception is thown if the argument is outside the range of a valid index.
UnsupportedOperationException This exception is thrown if the Style Catalog is in "read only" mode.

public abstract void remove (String name)

Removes the LayoutParserDefn object at the specified index.

Parameters
name The name of the layout parser definition object to remove.
Throws
IllegalArgumentException This exception is thrown if the argument does not match one of the stored names.
UnsupportedOperationException This exception is thrown if the Style Catalog is in "read only" mode.

public abstract 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.