Package com.microstrategy.web.transform

Class LayoutParserDefnsImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractElementList

com.microstrategy.web.transform.AbstractStyleCatalogList

com.microstrategy.web.transform.LayoutParserDefnsImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, LayoutParserDefns, java.lang.Cloneable

public class LayoutParserDefnsImpl
extends AbstractStyleCatalogList
implements LayoutParserDefns

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

Since:

MicroStrategy Web 8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ATT_GLOBAL_PARSER
protected static java.lang.String	NODE_LAYOUT_PARSER_DEFNS

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
LayoutParserDefnsImpl()

Method Summary

Modifier and Type	Method	Description
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.
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.
protected java.lang.Class	getListClass()	Returns the Class items beloging to this list will be instance of.
protected java.lang.String	getListNodeName()	Returns the name of the node representing children of this list.
LayoutParserDefn	newLayoutParserDefn(java.lang.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(java.lang.String name)	Removes an element from the collection
void	setGlobalParserName(java.lang.String value)	Sets the name of the global parser.

Methods inherited from class com.microstrategy.web.transform.AbstractStyleCatalogList

getCount, getStyleCatalog, newItem, reload

Methods inherited from class com.microstrategy.utils.config.AbstractElementList

clear, containsKey, get, get, getKeyAttribute, getList, isEmpty, put, put, size

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Methods inherited from interface com.microstrategy.web.transform.LayoutParserDefns

clear, getCount

Field Detail

ATT_GLOBAL_PARSER

protected static final java.lang.String ATT_GLOBAL_PARSER

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

NODE_LAYOUT_PARSER_DEFNS

protected static final java.lang.String NODE_LAYOUT_PARSER_DEFNS

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

LayoutParserDefnsImpl

public LayoutParserDefnsImpl()

Since:

MicroStrategy Web 9.0.0

Method Detail

clearCaches

protected void clearCaches()

Description copied from class: AbstractStyleCatalogList

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.

Overrides:

clearCaches in class AbstractStyleCatalogList

Since:

MicroStrategy Web 9.0.0

getGlobalParserName

public java.lang.String getGlobalParserName()

Description copied from interface: LayoutParserDefns

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

Specified by:

getGlobalParserName in interface LayoutParserDefns

Since:

MicroStrategy Web 9.0.0

setGlobalParserName

public void setGlobalParserName(java.lang.String value)

Description copied from interface: LayoutParserDefns

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

Specified by:

setGlobalParserName in interface LayoutParserDefns

Since:

MicroStrategy Web 9.0.0

getLayoutParserDefn

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

Description copied from interface: LayoutParserDefns

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

Specified by:

getLayoutParserDefn in interface LayoutParserDefns

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

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

Description copied from interface: LayoutParserDefns

Gets the LayoutParserDefn associated with a given name.

Specified by:

getLayoutParserDefn in interface LayoutParserDefns

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.

remove

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

Description copied from class: AbstractStyleCatalogList

Removes an element from the collection.

Specified by:

remove in interface LayoutParserDefns

Overrides:

remove in class AbstractStyleCatalogList

Parameters:

index - The position within the valid elements of the element 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

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

Description copied from class: AbstractStyleCatalogList

Removes an element from the collection

Specified by:

remove in interface LayoutParserDefns

Overrides:

remove in class AbstractStyleCatalogList

Parameters:

name - the key of the 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

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

Description copied from interface: LayoutParserDefns

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

Specified by:

newLayoutParserDefn in interface LayoutParserDefns

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

public LayoutParserDefn getGlobalParserDefn()

Description copied from interface: LayoutParserDefns

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

Specified by:

getGlobalParserDefn in interface LayoutParserDefns

Returns:

The global layout parser definition object.

getListClass

protected java.lang.Class getListClass()

Description copied from class: AbstractElementList

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

Specified by:

getListClass in class AbstractElementList

Since:

MicroStrategy Web 9.0.0

getListNodeName

protected java.lang.String getListNodeName()

Description copied from class: AbstractElementList

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

Specified by:

getListNodeName in class AbstractElementList

Since:

MicroStrategy Web 9.0.0