Package com.microstrategy.web.app

Class ExportFormatList

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.ExportFormatList

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class ExportFormatList
extends AbstractConfigurationElementList

This class defines a list of ExportFormat objects

Since:

MicroStrategy Web 7.3.1 or earlier

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	NODE_EXPORT_FORMATS

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
ExportFormatList()
ExportFormatList(org.w3c.dom.Document doc)	Class constructor.
ExportFormatList(org.w3c.dom.Node root)	Class constructor.

Method Summary

Modifier and Type	Method	Description
ExportFormat	getExportFormat(java.lang.String exportFormatName)	returns the ExportFormat bbject that corresponds to the name specified
boolean	isEmptyForBean(java.lang.String beanType, WebComponent baseBean)
ExportFormat	resolveSelectedExportFormat(java.lang.String selectedExportFormatName, java.lang.String beanType, java.lang.String viewMode, WebComponent baseBean)	Utility method to help resolve the selected export format.

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

clear, clone, get, get, getFilteredList, getKey, getKeyAttribute, 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_EXPORT_FORMATS

public static final java.lang.String NODE_EXPORT_FORMATS

See Also:

Constant Field Values

Constructor Detail

ExportFormatList

public ExportFormatList()

ExportFormatList

public ExportFormatList(org.w3c.dom.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.

ExportFormatList

public ExportFormatList(org.w3c.dom.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

Method Detail

getExportFormat

public ExportFormat getExportFormat(java.lang.String exportFormatName)

returns the ExportFormat bbject that corresponds to the name specified

Parameters:

exportFormatName - String value with the format name to look for

Returns:

the ExportFormat assocaited with the name

resolveSelectedExportFormat

public ExportFormat resolveSelectedExportFormat(java.lang.String selectedExportFormatName,
                                                java.lang.String beanType,
                                                java.lang.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

Since:

MicroStrategy Web 8.0.2

isEmptyForBean

public boolean isEmptyForBean(java.lang.String beanType,
                              WebComponent baseBean)

Since:

MicroStrategy Web 9.0.0