Package com.microstrategy.web.transform
Class AbstractStyleCatalogList
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.utils.config.AbstractElementList
-
- com.microstrategy.web.transform.AbstractStyleCatalogList
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationFile
,java.lang.Cloneable
- Direct Known Subclasses:
ActualParametersImpl
,BeanDefnsImpl
,LayoutParserDefnsImpl
,LayoutsImpl
,LayoutSourceDefnsImpl
,MapperDefnsImpl
,StyleMapsImpl
,StylesImpl
,TransformDefnsImpl
public abstract class AbstractStyleCatalogList extends AbstractElementList
This is the base class for lists defined in the style-catalog likeLayoutSourceDefns
orBeanDefns
. Subclasses need to override thegetListClass()
andgetListNodeName()
for this class to automatically identify the children's name and class.- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
AbstractConfigurationElement.FilteredList
-
-
Field Summary
-
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 AbstractStyleCatalogList()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.int
getCount()
Retuns the size of the collectionprotected StyleCatalog
getStyleCatalog()
Returns the instance of the StyleCatalog containing all the elements.protected AbstractStyleCatalogElement
newItem(java.lang.String name)
Creates a new item for this list with the given name as a key.void
reload()
Loops through all theElementSource
of thisConfigurationElement
and reloads the content of those whose underlying configuration file has changed.void
remove(int index)
Removes an element from the collection.void
remove(java.lang.String key)
Removes an element from the collection-
Methods inherited from class com.microstrategy.utils.config.AbstractElementList
clear, containsKey, get, get, getKeyAttribute, getList, getListClass, getListNodeName, 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
-
-
-
-
Method Detail
-
newItem
protected AbstractStyleCatalogElement newItem(java.lang.String name) throws java.lang.IllegalArgumentException
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:
java.lang.IllegalArgumentException
- if the name is empty or if the name is already in used.
-
remove
public void remove(java.lang.String key)
Removes an element from the collection- Parameters:
key
- the key of the object to remove
-
remove
public void remove(int index)
Removes an element from the collection.- Parameters:
index
- The position within the valid elements of the element to remove.
-
getCount
public int getCount()
Retuns the size of the collection- Returns:
- the size of the collection
-
reload
public void reload() throws ConfigException
Description copied from class:AbstractConfigurationElement
Loops through all theElementSource
of thisConfigurationElement
and reloads the content of those whose underlying configuration file has changed.- Specified by:
reload
in interfaceConfigurationElement
- Specified by:
reload
in interfaceConfigurationFile
- Overrides:
reload
in classAbstractConfigurationElement
- Throws:
ConfigException
-
clearCaches
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.
-
getStyleCatalog
protected StyleCatalog getStyleCatalog()
Returns the instance of the StyleCatalog containing all the elements.- Returns:
- StyleCatalog
-
-