public class

SectionInfo

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

Summary

Constants
String ATT_FILE_NAME
String ATT_NAME
String NODE_SECTION
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
SectionInfo()
Empty constructor of a SectionInfo initialize private fields with default values.
SectionInfo(Node root)
Creates a SectionInfo with the information in the xml node.
SectionInfo(String name, String fileName)
Constructor for an SectionInfo with the given the arguments.
Public Methods
String getFileName()
String getName()
void setFileName(String newValue)
void setName(String newValue)
Protected Methods
boolean fromDefault()
This method is deprecated. This method is not used by the application and will be removed in future versions of the product.
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.
void setFromDefault(boolean newValue)
This method is deprecated. This method is not used by the application and will be removed in future versions of the product.
[Expand]
Inherited Methods
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

Constants

public static final String ATT_FILE_NAME

Constant Value: "file-name"

public static final String ATT_NAME

Constant Value: "name"

public static final String NODE_SECTION

Constant Value: "page-section"

Public Constructors

public SectionInfo ()

Empty constructor of a SectionInfo initialize private fields with default values.

public SectionInfo (Node root)

Creates a SectionInfo with the information in the xml node.

Parameters
root An XML Node with the information for this event map.

public SectionInfo (String name, String fileName)

Constructor for an SectionInfo with the given the arguments.

Parameters
name the section name
fileName The name of the file to associate with this section

Public Methods

public String getFileName ()

Returns
  • the fileName associated with this section

public String getName ()

Returns
  • the name of the section

public void setFileName (String newValue)

public void setName (String newValue)

Protected Methods

protected boolean fromDefault ()

This method is deprecated.
This method is not used by the application and will be removed in future versions of the product.

Returns whether the section it comes from a default on the default page

Returns
  • true if the section it comes from a default on the default page

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.

protected void setFromDefault (boolean newValue)

This method is deprecated.
This method is not used by the application and will be removed in future versions of the product.

Indicates the section it comes from a default on the default page

Parameters
newValue boolean value