public class

PropertySet

extends AbstractConfigurationElementList
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractConfigurationElementList
       ↳ com.microstrategy.web.app.PropertySet

Class Overview

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

Summary

Constants
String ATT_NAME
String NODE_PROPERTY_SET constant for the propertySet node name
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
PropertySet()
Class constructor.
PropertySet(String name)
Class constructor.
PropertySet(Node root)
Class constructor.
Public Methods
String getName()
Get the name of the PropertySet instance
HashList getProperties()
This method is deprecated. For performance reasons, it's better to use getPropertyList()
Property getProperty(String propertyName)
AbstractConfigurationElement.FilteredList getPropertyList()
Get the list of propertied
void setName(String name)
Set the name of the PropertySet instance
Protected Methods
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.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElementList
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.ConfigurationElementList
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_NAME

Constant Value: "name"

public static final String NODE_PROPERTY_SET

constant for the propertySet node name

Constant Value: "propertySet"

Public Constructors

public PropertySet ()

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

public PropertySet (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.

public PropertySet (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.

Public Methods

public String getName ()

Get the name of the PropertySet instance

Returns
  • the String value of the name property.

public HashList getProperties ()

This method is deprecated.
For performance reasons, it's better to use getPropertyList()

Get the list of propertied

Returns
  • list of properties

public Property getProperty (String propertyName)

Parameters
propertyName string representing the name of the Property to return
Returns

public AbstractConfigurationElement.FilteredList getPropertyList ()

Get the list of propertied

Returns
  • list of properties

public void setName (String name)

Set the name of the PropertySet instance

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

Protected Methods

protected 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.