public class

ExportFormat

extends AbstractConfigurationElement

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

Class Overview

Defines the properties of a single export format supported by the application. The application presents this export-format to the user when the export functionality is used.

Summary

Constants
String	ATT_BEAN_TYPE
String	ATT_CHARSET
String	ATT_CODEPAGE
String	ATT_DESCRIPTION
String	ATT_DESC_ID
String	ATT_EXECUTION_MODE
String	ATT_EXPORT_FORMAT_TYPE
String	ATT_FEATURE
String	ATT_FILE_EXTENSION
String	ATT_FORCE_DOWNLOAD
String	ATT_MIME_TYPE
String	ATT_NAME
String	ATT_PAGE_NAME
String	ATT_SAVE_REPORT_PROPS	This constant is deprecated. we now save properties for all formats
String	ATT_STYLE
String	ATT_VIEW_MODE
String	NODE_EXPORT_FORMAT

[Expand]

Inherited Constants

From class com.microstrategy.utils.config.AbstractConfigurationElement

Public Constructors
	ExportFormat() Class constructor.
	ExportFormat(Node root) Class constructor.

Public Methods
String	getBeanType() Returns the bean to which the export format belongs.
String	getCharset(AppContext appContext)
int	getCodepage(AppContext appContext)
String	getDescription() Returns a description that the application should use to display the export format if the desc-id attribute is missing.
String	getDescriptorID() Returns the Resource Bundle item id that the application should use to display the export format in the language of the user's locale.
String	getExecutionMode() Returns the execution mode that the export format uses.
String	getExportFormatType() Returns the type of this export format.
String	getFeature() Returns the id of a feature that is evaluated to determine whether the export-format should be displayed as an option.
String	getFileExtension() Returns the extension that the application gives to the file that is created when exporting using the export format.
boolean	getForceDownload()
String	getMessage(Messages messages)
String	getMimeType() Returns the mime-type that the export format uses.
String	getName() Returns the export-format's name, a unique identifier for the export-format.
String	getPageName() Returns the page's name that the application uses when exporting using the specified export format.
boolean	getSaveReportProps() This method is deprecated. we now save properties for all formats
String	getStyle() Returns the name of a style (from the Style Catalog) that is used to transform the corresponding bean when exporting using the export format.
String	getViewMode() Returns the view mode that the export format uses.
String	getViewModeName() This method is deprecated. use getViewMode()
boolean	isCsvOrExcelWithPlaintext(AppContext appContext)
boolean	isExcel() Whether the export format is for Excel with plaintext or Excel with formatting Determined based on the export format type property
boolean	isExportFormatAvailable(String beanType, String viewMode, WebComponent baseBean) Utility method to determine if an export format is available based on the bean type, view mode and feature-id if present.
boolean	isPlainText() Whether the export format is plaintext (Excel with plaintext, CSV or Plaintext) Determined based on the export format type property.
boolean	isRealPlainText(AppContext appContext) Whether the export format is plaintext.
void	setBeanType(String beanType) Indicates the bean to which the export format belongs.
void	setCharset(boolean charset) Set the charset to use when exporting.
void	setCodepage(boolean codepage) Set the codepage to use on ASP.NET when exporting.
void	setDescription(String description) Provides a descriptor that the application should use to display the export format if the desc-id attribute is missing.
void	setDescriptorID(String descriptorID) Indicates the Resource Bundle item id that the application should use to display the export format in the language of the user's locale.
void	setExecutionMode(String executionMode) Indicates the execution mode that the export format uses.
void	setExportFormatType(String exportFormatType) Sets the type of this export format.
void	setFeature(String feature) Sets the name of a feature that is evaluated to determine whether the export-format should be displayed as an option.
void	setFileExtension(String fileExtension) Sets the extension that the application will give to the file that is created when exporting using the export format.
void	setForceDownload(boolean forceDownload) Set whether to force the browser to download the file by adding "attachment" to the Content-Disposition HTTP header
void	setMimeType(String mimeType) Indicates the mime-type that the export format should use.
void	setName(String exportFormatName) Sets the export-format's name, which needs to be a unique identifier for the export-format.
void	setPageName(String pageName) Indicates the page that the application will use when exporting using this ExportFormat.
void	setSaveReportProps(boolean saveReportProps) This method is deprecated. we now save properties for all formats
void	setStyle(String style) Indicatges the name of a style (from the Style Catalog) that is used to transform the corresponding bean when exporting using the export format.
void	setViewMode(String viewMode) Indicates the view mode that the export format uses.
void	setViewModeName(String viewModeName) This method is deprecated. use setViewMode()

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.
void	initDefaultAttributes() This method can be overridden to set default values for attributes.

[Expand]

Inherited Methods

From class com.microstrategy.utils.config.AbstractConfigurationElement

void	addFileSource(String filePath, String appPath, long lastLoaded) Adds a reference to a file from a config-source.
void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
void	cleanUpDeletedElements() This method when called will delete all the child elements that are marked as deleted.
Object	clone()
void	delete(Object key)
AbstractConfigurationElement	deltas(AbstractConfigurationElement other) Returns a partial instance of this object that contains the attributes and elements required to make this object equals to the `other` paramter.
final AbstractConfigurationElement	deltas() Returns the `deltas` between the `original()` and `this` objects.
boolean	equalAtts(AbstractConfigurationElement other) Returns `true` if the list of active attributes of the given AbstractConfigurationElement is equal to this list of active attributes of this AbstractConfigurationElement.
boolean	equalElements(AbstractConfigurationElement other) Returns `true` if the list of all child elements of the given AbstractConfigurationElement is equal to this list of all child-elements of this AbstractConfigurationElement.
boolean	equalNodeValues(AbstractConfigurationElement other) Returns `true` if the node value of both configuration elements is the same.
boolean	equals(Object object)
boolean	equalsIncludingDeletedElements(Object object)
void	exportAttributesToXML(Element element, ConfigurationSource source) Appends the list of attributes of this `ConfigurationElement` into the given node.
void	exportElementsToXML(Element element, ConfigurationSource source) Appends the list of child-elements of this `ConfigurationElement` into the given node.
void	exportNodeValueToXML(Element element, ConfigurationSource source) Appends the node value associated with the given source key into the given node.
final ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
boolean	getBoolAttribute(String name) Helper method, returns the value of the given attribute as boolean (true/false).
Object	getChildKey(Node node) Returns the key that uniquely identifies the child element associated with the given `Node`.
String	getConfigSrc() Returns the value of the config-src attribute.
String	getDTDFileName() Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; `null` by default.
ConfigurationElement	getElement(Object key, boolean includeDeleted)
ConfigurationElement	getElement(Object key) Returns the `ConfigurationElement` instance associated with the given nodeName.
final HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
FileLoader	getFileLoader() Returns the file loader instance used by this ConfigurationElement to load files from the file system.
int	getIntAttribute(String name, int defaultValue) Helper method, returns the value of the given attribute as integer.
int	getIntAttribute(String name) Helper method, returns the value of the given attribute as integer.
Object	getKey() Default implementation for `getKey()`.
abstract 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.
int	getLineNumber() Returns the line number (if known) of the element in the XML file.
AbstractConfigurationElement.FilteredList	getList(String nodeName) Returns an `ImplicitList` with all the elements associated with the given `nodeName`.
Object	getNextKey() Returns an object that can be used as key for a list of child-elements that doesn't have a key by itself.
String	getNodeName() Returns the node-name for this element.
String	getNodeValue() Returns the node value for this element.
String	getNodeValue(ConfigurationSource source) Returns the node value for this element in the given sourceKey.
AbstractConfigurationElement	getOrCreateElement(String nodeName, Object key) Returns the current child instance; if null but the child is registered, it creates a new instance for it.
AbstractConfigurationElement	getParent() Gets the parent for this configuration element.
int	getPosition() Returns the expected position of this element.
AbstractConfigurationElement	getPrototype() Returns the current prototype of this instance.
Class	getRegisteredClass(String nodeName) Returns the `Class` associated with the given `nodeName`.
String	getSelfInitPath() Returns the path to the file where this configuration element was originally loaded from.
ConfigurationSource	getSource(String key) Gets the `ElementSource` for the given key.
String	getStrAttribute(String name) Helper method, returns the value of the given attribute as a string.
boolean	getUseDefault() Returns the use-default value.
ParserParameters	getXMLParserParameters(String fileName) Returns an instance of `ParserParameters` used by the XML parser.
SerializerParameters	getXMLSerializerParameters() Returns an instance of `SerializerParameters` used by the XML serializer in the `toXML()` By default it returns `null`.
boolean	hasRegisteredClass(String nodeName) Returns `true` is there is a child registered for the given `nodeName`.
int	hashCode()
int	hashCodeAtts() Returns the hashcode for attributes.
int	hashCodeElements() Returns the hashcode for attributes.
int	hashCodeNodeValues() Returns the hashcode for attributes.
void	initAttributesFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of attributes from given `Node`
void	initDefaultAttributes() This method can be overridden to set default values for attributes.
void	initElementFromXML(Node child, String sourceKey, CustomizationInfo c) Initializes a single child-element from the given `Node`
void	initElementsFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initFromFile(String filePath, CustomizationInfo c) Initializes this configuration element by loading the contents of the given `filePath` using the corresponding `CustomizationInfo`.
void	initFromResource(String resourceName) Initializes this configuration element by loading the contents a resource that exists in the class path.
void	initFromXML(Node root, String sourceKey, CustomizationInfo c) Initialize the attributes and child elements from the values in the given `Node`
void	initFromXML(Node root) Initialize the attributes and child elements from the values in the given `Node`
void	initNodeValueFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initPrototype(String protoName) Inits the prototype object of this element.
boolean	isActive()
boolean	isCustomized()
boolean	isDeleted() Returns `true` is this element has been mark as deleted.
boolean	isDirty() Returns `true` is this element or one of its children has been modified programatically after being loaded.
boolean	isInSource(String sourceKey) Returns `true` if the element already contains an `ElementSource` for the given key.
boolean	isKeyAttribute(String name) Returns `true` is the name is that of the key attribute.
void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationElement` with its content.
void	mergeChanges(String srcKey) Removes deltas and applies them to the given source.
AbstractConfigurationElement	newChildInstance(String nodeName, Class childClass) Creates a new instance of a child element for the given class.
ConfigurationSource	newSource(String srcKey, CustomizationInfo c) Create a new `ElementSource` and adds to the list of sources of this element.
final AbstractConfigurationElement	original() Returns a new instance of this object, populated only with the out of the box values of Microstrategy Web, that is, only default values or those that came from the load method.
ConfigurationElement	populate(ConfigurationElement other) This method takes another configuration element and populates this element with the other's attributes and child-elements.
void	printAttributes(StringBuffer outString) Appends the list of attributes of this `ConfigurationElement` into the given `StringBuffer`.
void	printElements(StringBuffer outString) Appends the list of child-elements of this `ConfigurationElement` into the given `StringBuffer`.
void	printNodeValue(StringBuffer outString) Appends the node value into the given `StringBuffer`.
void	refreshLists()
void	registerClass(String nodeName, Class c) Registers a child class for the child with the given `nodeName`.
void	registerElement(String nodeName, Class c) Register a child of this `ConfigurationElement`.
void	registerElement(String nodeName, Class c, boolean canBeNull) Register a child of this `ConfigurationElement`.
void	registerElementList(String nodeName, Class c) Register a list of this `ConfigurationElement`.
void	reload() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	reloadPrototype() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	removeAttribute(String name) Completely remove the value for the given attribute.
void	removeDefaults(CustomizationInfo c) This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.
void	replaceList(AbstractConfigurationElement.FilteredList list)
void	restore(Object key)
void	save(CustomizationInfo c) Saves deltas for this `ConfigurationElement` into the given CustomizationInfo.
void	save() Saves this `ConfigurationElement` back into the files where it was loaded from.
void	saveChangesAs(String fileName) Saves all in-memory changes to the given file.
final void	saveConfig(String filePath) This method is deprecated. To save in a different location, set a custom FileLoader and use the save() method.
void	saveFlatXML(String fileName) Saves the current element structure, in XML format, into the given file.
void	saveNode(Node node, String fileLocation) Saves an XML node into a file in the given location.
void	saveSource(ConfigurationSource source) Saves only the contents associated with the given source.
void	setAttribute(String name, Object value) Sets the value for the given attribute.
void	setBoolAttribute(String name, boolean value) Helper method, sets the value of the given attribute from a boolean.
void	setChildOriginals()
void	setConfigSrc(String path) Sets the config-src attribute.
void	setCustomized(boolean value) set if this element is a customized element or not.
void	setElement(Object key, ConfigurationElement child) Allows users to add or replace an element.
void	setFileLoader(FileLoader fl) Sets the `FileLoader` instance to be used to load files.
void	setIntAttribute(String name, int value) Helper method, sets the value of the given attribute from an integer.
void	setKey(Element element) Default implementation for `setKey()`.
void	setLineNumber(int lineNumber) Sets the line number of the element in the XML file.
void	setNodeName(String name) Sets the name of the node associated with this configuration element.
void	setNodeValue(String value) Returns the node value for this element.
void	setPosition(int position) Sets the expected position of this element.
void	setPrototype(AbstractConfigurationElement prototype) Sets the prototype object for this instance.
void	setSelfInitPath(String value)
void	setStrAttribute(String name, String value) Helper method, sets the value of the given attribute as a string.
void	setUseDefault(boolean useDefault) The definition of a ConfigurationElement can come come from different sources, for example, the definition can come from an external file (by specifying a `getConfigSrc()` value), or it can be modified through a Customization.
void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
String	toString() Generates the String representation of this `ConfigurationElement`.
Element	toXML(Document doc, String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
synchronized Element	toXML(Document doc) Generates the DOM representation of this `ConfigurationElement`.
synchronized Element	toXML() Generates the DOM representation of this `ConfigurationElement`.
Element	toXML(String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
boolean	useNodeValue() Controls whether this element will use the node value as a property.
boolean	useValidation() Returns whether the XML content should be validated using a DTD.

From class java.lang.Object

From interface com.microstrategy.utils.config.ConfigurationElement

abstract ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
abstract HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
abstract ConfigurationElement	getElement(Object nodeName) Returns the `ConfigurationElement` instance associated with the given nodeName.
abstract HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
abstract Object	getKey() This method is used to uniquely identify this ConfigurationElement within a list.
abstract String	getNodeName() Returns the node-name for this element.
abstract String	getStrAttribute(String name)
abstract void	initFromXML(Node root) Initializes the object with information from an XML Node.
abstract void	reload() Triggers the re-initialization of the element and its children if the configuration files have changed.
abstract Element	toXML(Document doc) Utility method to get the object's XML representation.

From interface com.microstrategy.utils.config.ConfigurationFile

abstract void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
abstract void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
abstract void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationFile` with its content.
abstract void	reload() Reloads the content of this `ConfigurationFile` if the underlying configuration file has changed.
abstract void	save() Saves this `ConfigurationFile` back into the files where it was loaded from.
abstract void	save(CustomizationInfo c) Saves the differences between the shipped ("out of the box") definition of this `ConfigurationFile` and its currents values into the corresponding `CustomizationInfo`.
abstract void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
abstract boolean	useValidation() Returns whether the XML content should be validated using a DTD.

Constants

public static final String ATT_BEAN_TYPE

Constant Value: "bean-type"

public static final String ATT_CHARSET

Constant Value: "charset"

public static final String ATT_CODEPAGE

Constant Value: "codepage"

public static final String ATT_DESCRIPTION

Constant Value: "desc"

public static final String ATT_DESC_ID

Constant Value: "desc-id"

public static final String ATT_EXECUTION_MODE

Constant Value: "execution-mode"

public static final String ATT_EXPORT_FORMAT_TYPE

Constant Value: "export-format-type"

public static final String ATT_FEATURE

Constant Value: "feature-id"

public static final String ATT_FILE_EXTENSION

Constant Value: "file-extension"

public static final String ATT_FORCE_DOWNLOAD

Constant Value: "force-download"

public static final String ATT_MIME_TYPE

Constant Value: "mime-type"

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_PAGE_NAME

Constant Value: "page-name"

public static final String ATT_SAVE_REPORT_PROPS

This constant is deprecated.
we now save properties for all formats

Constant Value: "save-report-props"

public static final String ATT_STYLE

Constant Value: "style"

public static final String ATT_VIEW_MODE

Constant Value: "view-mode"

public static final String NODE_EXPORT_FORMAT

Constant Value: "export-format"

Public Constructors

public ExportFormat ()

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

public ExportFormat (Node root)

Class constructor. Initializes an Export format instance based on the information included on the XML Node

Parameters

root	Node instance representing the export format information.

Public Methods

public String getBeanType ()

Returns the bean to which the export format belongs. In the export dialog this attributes dictactes which format to display depending on the object being exported (report, document or HTML Document).

public String getCharset (AppContext appContext)

Parameters

appContext	the application's context

Returns

the charset to use when exporting.
If not specified we read this from the value specified on the locales.xml like this:

public int getCodepage (AppContext appContext)

Parameters

appContext	the application's context

Returns

the codepage to use on ASP.NET when exporting.
If not specified we read this from the value specified on the locales.xml like this:

public String getDescription ()

Returns a description that the application should use to display the export format if the desc-id attribute is missing.

public String getDescriptorID ()

Returns the Resource Bundle item id that the application should use to display the export format in the language of the user's locale.

public String getExecutionMode ()

Returns the execution mode that the export format uses. It returns the actual (resolved) value from the EnumRWExecutionModes enumeration, or null if the value is underined.

public String getExportFormatType ()

Returns the type of this export format. It returns the actual (resolved) value from the EnumExportFormats enumeration or null if the value is undefined.

public String getFeature ()

Returns the id of a feature that is evaluated to determine whether the export-format should be displayed as an option.

public String getFileExtension ()

Returns the extension that the application gives to the file that is created when exporting using the export format.

public boolean getForceDownload ()

Returns

whether to force the browser to download the file by adding "attachment" to the Content-Disposition HTTP header

public String getMessage (Messages messages)

Parameters

messages	the messages l10n object.

Returns

the export format's localized descriptor, or the description if the descriptionId is empty.

public String getMimeType ()

Returns the mime-type that the export format uses. This type is used by the browser to identify the type of content being sent.

public String getName ()

Returns the export-format's name, a unique identifier for the export-format.

public String getPageName ()

Returns the page's name that the application uses when exporting using the specified export format.

public boolean getSaveReportProps ()

This method is deprecated.
we now save properties for all formats

Returns whether the options selected by the user in the export dialog should be saved back as part of the report-properties.

public String getStyle ()

Returns the name of a style (from the Style Catalog) that is used to transform the corresponding bean when exporting using the export format. It only applies in export-formats that are used for reports

public String getViewMode ()

Returns the view mode that the export format uses. It returns the actual (resolved) value from the ReportViewModeGrid enumeration. If the view mode is not defined, it returns null.

public String getViewModeName ()

This method is deprecated.
use getViewMode()

Returns

the view mode name of this export format

public boolean isCsvOrExcelWithPlaintext (AppContext appContext)

public boolean isExcel ()

Whether the export format is for Excel with plaintext or Excel with formatting
Determined based on the export format type property

Returns

boolean whether the export format is for Excel

public boolean isExportFormatAvailable (String beanType, String viewMode, WebComponent baseBean)

Utility method to determine if an export format is available based on the bean type, view mode and feature-id if present.

Parameters

beanType	The Export Format's 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

whether the export format is available

public boolean isPlainText ()

Whether the export format is plaintext (Excel with plaintext, CSV or Plaintext)
Determined based on the export format type property.

Returns

boolean whether the export format is plaintext

public boolean isRealPlainText (AppContext appContext)

Whether the export format is plaintext.

Parameters

appContext	the application's context

Returns

whether the export format is plaintext

public void setBeanType (String beanType)

Indicates the bean to which the export format belongs. In the export dialog this attributes dictactes which format to display depending on the object being exported (report, document or HTML Document). Possible values are:

ReportBean
DocumentBean
RWBean

public void setCharset (boolean charset)

Set the charset to use when exporting.
If not specified we read this from the value specified on the locales.xml like this:

Parameters

charset	the charset to use when exporting.

public void setCodepage (boolean codepage)

Set the codepage to use on ASP.NET when exporting.
If not specified we read this from the value specified on the locales.xml like this:

Parameters

codepage	the codepage to use on ASP.NET when exporting.

public void setDescription (String description)

Provides a descriptor that the application should use to display the export format if the desc-id attribute is missing.

public void setDescriptorID (String descriptorID)

Indicates the Resource Bundle item id that the application should use to display the export format in the language of the user's locale.

public void setExecutionMode (String executionMode)

Indicates the execution mode that the export format uses. This execution-mode applies only to export formats that are used for documents, that is their bean-type is "RWBean". The values of the attribute are expressed using the fully-qualified name of the constants defined in the EnumRWExecutionModes enumeration for example, "com.microstrategy.web.objects.rw.EnumRWExecutionModes.RW_MODE_PDF".

public void setExportFormatType (String exportFormatType)

Sets the type of this export format. The value must be a valid fully-qualified name of the values defined in this EnumExportFormats internface, for example, "com.microstrategy.web.app.beans.EnumExportFormats.ExportFormatExcelWithPlaintext".

Parameters

exportFormatType	the export format type to be used on this export format.

public void setFeature (String feature)

Sets the name of a feature that is evaluated to determine whether the export-format should be displayed as an option.

public void setFileExtension (String fileExtension)

Sets the extension that the application will give to the file that is created when exporting using the export format.

public void setForceDownload (boolean forceDownload)

Set whether to force the browser to download the file by adding "attachment" to the Content-Disposition HTTP header

Parameters

forceDownload	whether to force the browser to download the file by adding "attachment" to the Content-Disposition HTTP header

public void setMimeType (String mimeType)

Indicates the mime-type that the export format should use. This type is used by the browser to identify the type of content being sent.

public void setName (String exportFormatName)

Sets the export-format's name, which needs to be a unique identifier for the export-format.

public void setPageName (String pageName)

Indicates the page that the application will use when exporting using this ExportFormat.

public void setSaveReportProps (boolean saveReportProps)

This method is deprecated.
we now save properties for all formats

Indicates whether the options selected by the user in the export dialog should be saved back as part of the report-properties.

public void setStyle (String style)

Indicatges the name of a style (from the Style Catalog) that is used to transform the corresponding bean when exporting using the export format. This attribute applies only to export formats that are used for reports (i.e. their beantype is ReportBean) , but in this case it is always required to have a valid value.

public void setViewMode (String viewMode)

Indicates the view mode that the export format uses. The values of the attribute are expressed using the fully-qualified name of the constants defined in the EnumWebReportViewMode interface for example, "com.microstrategy.web.objects.EnumWebReportViewMode.ReportViewModeGrid").

public void setViewModeName (String viewModeName)

This method is deprecated.
use setViewMode()

Set the view mode name of this export format to the given parameter

Parameters

viewModeName	the view mode used on this export format.

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.

protected void initDefaultAttributes ()

This method can be overridden to set default values for attributes. Simply extend this method and call setAttribute(String, Object)

Interfaces

Classes

Exceptions

ExportFormat

Class Overview

Summary

Constants

public static final String ATT_BEAN_TYPE

public static final String ATT_CHARSET

public static final String ATT_CODEPAGE

public static final String ATT_DESCRIPTION

public static final String ATT_DESC_ID

public static final String ATT_EXECUTION_MODE

public static final String ATT_EXPORT_FORMAT_TYPE

public static final String ATT_FEATURE

public static final String ATT_FILE_EXTENSION

public static final String ATT_FORCE_DOWNLOAD

public static final String ATT_MIME_TYPE

public static final String ATT_NAME

public static final String ATT_PAGE_NAME

public static final String ATT_SAVE_REPORT_PROPS

public static final String ATT_STYLE

public static final String ATT_VIEW_MODE

public static final String NODE_EXPORT_FORMAT

Public Constructors

public ExportFormat ()

public ExportFormat (Node root)

Parameters

Public Methods

public String getBeanType ()

See Also

public String getCharset (AppContext appContext)

Parameters

Returns

public int getCodepage (AppContext appContext)

Parameters

Returns

public String getDescription ()

public String getDescriptorID ()

public String getExecutionMode ()

public String getExportFormatType ()

public String getFeature ()

public String getFileExtension ()

public boolean getForceDownload ()

Returns

public String getMessage (Messages messages)

Parameters

Returns

public String getMimeType ()

public String getName ()

public String getPageName ()

public boolean getSaveReportProps ()

public String getStyle ()

public String getViewMode ()

public String getViewModeName ()

Returns

public boolean isCsvOrExcelWithPlaintext (AppContext appContext)

public boolean isExcel ()

Returns

public boolean isExportFormatAvailable (String beanType, String viewMode, WebComponent baseBean)

Parameters

Returns

public boolean isPlainText ()

Returns

public boolean isRealPlainText (AppContext appContext)

Parameters

Returns

public void setBeanType (String beanType)

public void setCharset (boolean charset)

Parameters

public void setCodepage (boolean codepage)

Parameters

public void setDescription (String description)

public void setDescriptorID (String descriptorID)

public void setExecutionMode (String executionMode)

public void setExportFormatType (String exportFormatType)

Parameters

public void setFeature (String feature)

public void setFileExtension (String fileExtension)

public void setForceDownload (boolean forceDownload)