Package com.microstrategy.web.transform

Interface LayoutParserDefns

All Superinterfaces:

java.lang.Cloneable, ConfigurationElement

All Known Implementing Classes:

LayoutParserDefnsImpl

public interface LayoutParserDefns
extends ConfigurationElement

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.

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the collection of layout parser definition objects.
int	getCount()	Returns the number of LayoutParserDefn objects in this collection.
LayoutParserDefn	getGlobalParserDefn()	Returns the "global" layout parser definition object associated with this Style Catalog.
java.lang.String	getGlobalParserName()	Returns the name of the global parser currently associated with this collection
LayoutParserDefn	getLayoutParserDefn(int index)	Gets the LayoutParserDefn associated with supplied index.
LayoutParserDefn	getLayoutParserDefn(java.lang.String name)	Gets the LayoutParserDefn associated with a given name.
LayoutParserDefn	newLayoutParserDefn(java.lang.String layoutParserName)	Creates a new layout parser definition object with the supplied name.
void	remove(int index)	Removes the LayoutParserDefn object at the specified index.
void	remove(java.lang.String name)	Removes the LayoutParserDefn object at the specified index.
void	setGlobalParserName(java.lang.String value)	Sets the name of the global parser.

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Method Detail

getCount

int getCount()

Returns the number of LayoutParserDefn objects in this collection.

Returns:

The count of layout parser definition objects.

getLayoutParserDefn

LayoutParserDefn getLayoutParserDefn(int index)
                              throws java.lang.IndexOutOfBoundsException

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:

The LayoutParserDefn at the supplied index.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.

getLayoutParserDefn

LayoutParserDefn getLayoutParserDefn(java.lang.String name)
                              throws java.lang.IllegalArgumentException

Gets the LayoutParserDefn associated with a given name.

Parameters:

name - The name of the layout parser definition object to return.

Returns:

The LayoutParserDefn object with the supplied name.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the argument does not match one of the stored names.

clear

void clear()
    throws java.lang.UnsupportedOperationException

Clears the collection of layout parser definition objects.

Throws:

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

remove

void remove(int index)
     throws java.lang.IndexOutOfBoundsException,
            java.lang.UnsupportedOperationException

Removes the LayoutParserDefn object at the specified index.

Parameters:

index - The index of the layout parser definition object to remove.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thown if the argument is outside the range of a valid index.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

remove

void remove(java.lang.String name)
     throws java.lang.IllegalArgumentException,
            java.lang.UnsupportedOperationException

Removes the LayoutParserDefn object at the specified index.

Parameters:

name - The name of the layout parser definition object to remove.

Throws:

java.lang.IllegalArgumentException - This exception is thrown if the argument does not match one of the stored names.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

newLayoutParserDefn

LayoutParserDefn newLayoutParserDefn(java.lang.String layoutParserName)
                              throws java.lang.IllegalArgumentException,
                                     java.lang.UnsupportedOperationException

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:

java.lang.IllegalArgumentException - This exception is thrown if the argument already matches one of the stored names.

java.lang.UnsupportedOperationException - This exception is thrown if the Style Catalog is in "read only" mode.

getGlobalParserDefn

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(java.lang.String) method.

Returns:

The global layout parser definition object.

getGlobalParserName

java.lang.String getGlobalParserName()

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

Since:

MicroStrategy Web 9.0.0

setGlobalParserName

void setGlobalParserName(java.lang.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.

Since:

MicroStrategy Web 9.0.0