Package com.microstrategy.web.app

Class PropertySet

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.PropertySet

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class PropertySet
extends AbstractConfigurationElementList

The PropertySet class encapsulates information about property sets used to store formatting properties

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
static java.lang.String	ATT_NAME
static java.lang.String	NODE_PROPERTY_SET	constant for the propertySet node name

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

ATT_VERSION

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
PropertySet()	Class constructor.
PropertySet(java.lang.String name)	Class constructor.
PropertySet(org.w3c.dom.Node root)	Class constructor.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getKeyAttribute()	This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
java.lang.String	getName()	Get the name of the PropertySet instance
HashList	getProperties()	Deprecated. For performance reasons, it's better to use getPropertyList()
Property	getProperty(java.lang.String propertyName)
AbstractConfigurationElement.FilteredList	getPropertyList()	Get the list of propertied
void	setName(java.lang.String name)	Set the name of the PropertySet instance

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

clear, clone, get, get, getFilteredList, getKey, getList, getValues, getVersion, init, isEmpty, put, put, registerElementInList, remove, setVersion, size, sort

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

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, 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, reload, 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

Field Detail

NODE_PROPERTY_SET

public static final java.lang.String NODE_PROPERTY_SET

constant for the propertySet node name

See Also:

Constant Field Values

ATT_NAME

public static final java.lang.String ATT_NAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

PropertySet

public PropertySet()

Class constructor. Initializes a new -empty- instance of the PropertySet class.

PropertySet

public PropertySet(java.lang.String name)

Class constructor. Initializes a new instance of the PropertySet class with the information given as parameters

Parameters:

name - unique name -identifier- for the PropertySet.

PropertySet

public PropertySet(org.w3c.dom.Node root)

Class constructor. Initializes a PropertySet instance based on the information included on the XML Node

Parameters:

root - Node instance representing the PropertySet information.

Method Detail

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

Overrides:

getKeyAttribute in class AbstractConfigurationElementList

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Get the name of the PropertySet instance

Returns:

the String value of the name property.

setName

public void setName(java.lang.String name)

Set the name of the PropertySet instance

Parameters:

name - the String value of the name property - unique identifier of the PropertySet instance.

getPropertyList

public AbstractConfigurationElement.FilteredList getPropertyList()

Get the list of propertied

Returns:

list of properties

Since:

MicroStrategy Web 9.0.0

getProperties

public HashList getProperties()

Deprecated.

For performance reasons, it's better to use getPropertyList()

Get the list of propertied

Returns:

list of properties

getProperty

public Property getProperty(java.lang.String propertyName)

Parameters:

propertyName - string representing the name of the Property to return

Returns:

a Property by its name.