public class

ExportFormatList

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

Class Overview

This class defines a list of ExportFormat objects

Summary

Constants
String NODE_EXPORT_FORMATS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ExportFormatList()
ExportFormatList(Node root)
Class constructor.
ExportFormatList(Document doc)
Class constructor.
Public Methods
ExportFormat getExportFormat(String exportFormatName)
returns the ExportFormat bbject that corresponds to the name specified
boolean isEmptyForBean(String beanType, WebComponent baseBean)
ExportFormat resolveSelectedExportFormat(String selectedExportFormatName, String beanType, String viewMode, WebComponent baseBean)
Utility method to help resolve the selected export format.
[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 NODE_EXPORT_FORMATS

Constant Value: "export-formats"

Public Constructors

public ExportFormatList ()

public ExportFormatList (Node root)

Class constructor. Creates a new instance of the ExportFormatList, initializing it with the information provided on an xml Node.

Parameters
root Node instance representing the different exportformats information.

public ExportFormatList (Document doc)

Class constructor. Creates a new instance of the ExportFormatList, initializing it with the information provided on an xml Document.

Parameters
doc DOM Document with information to initialize this class

Public Methods

public ExportFormat getExportFormat (String exportFormatName)

returns the ExportFormat bbject that corresponds to the name specified

Parameters
exportFormatName String value with the format name to look for
Returns

public boolean isEmptyForBean (String beanType, WebComponent baseBean)

public ExportFormat resolveSelectedExportFormat (String selectedExportFormatName, String beanType, String viewMode, WebComponent baseBean)

Utility method to help resolve the selected export format. Used for when the export format specified (selectedExportFormatName) is not available.

Parameters
selectedExportFormatName The selected export format name
beanType The export Format bean type
viewMode The report's view mode
baseBean The base bean used to solve the feature-id on the export format if any.
Returns
  • The selected export format