public abstract class

AbstractStyleCatalogList

extends AbstractElementList
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractElementList
       ↳ com.microstrategy.web.transform.AbstractStyleCatalogList
Known Direct Subclasses

Class Overview

This is the base class for lists defined in the style-catalog like LayoutSourceDefns or BeanDefns. Subclasses need to override the getListClass() and getListNodeName() for this class to automatically identify the children's name and class.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
AbstractStyleCatalogList()
Public Methods
int getCount()
Retuns the size of the collection
void reload()
Loops through all the ElementSource of this ConfigurationElement and reloads the content of those whose underlying configuration file has changed.
void remove(int index)
Removes an element from the collection.
void remove(String key)
Removes an element from the collection
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.
StyleCatalog getStyleCatalog()
Returns the instance of the StyleCatalog containing all the elements.
AbstractStyleCatalogElement newItem(String name)
Creates a new item for this list with the given name as a key.
[Expand]
Inherited Methods
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

Public Constructors

public AbstractStyleCatalogList ()

Public Methods

public int getCount ()

Retuns the size of the collection

Returns
  • the size of the collection

public void reload ()

Loops through all the ElementSource of this ConfigurationElement and reloads the content of those whose underlying configuration file has changed.

public void remove (int index)

Removes an element from the collection.

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

public void remove (String key)

Removes an element from the collection

Parameters
key the key of the object to remove

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 StyleCatalog getStyleCatalog ()

Returns the instance of the StyleCatalog containing all the elements.

Returns
  • StyleCatalog

protected AbstractStyleCatalogElement newItem (String name)

Creates a new item for this list with the given name as a key. The item is automatically set the "name" attribute with the given name, and added to this list.

Throws
IllegalArgumentException if the name is empty or if the name is already in used.