public interface

WebReportPlainTextExportSettings

implements WebReportExportSettings
com.microstrategy.web.objects.WebReportPlainTextExportSettings

Class Overview

This interface defines export settings that are specific to plain text exporting i.e exporting correspoding to the following types

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.objects.WebReportExportSettings
Public Methods
abstract boolean getDisplayAttributeForm()
Returns the current setting of whether to display attribute forms.
abstract String getHeaderPostfix()
Returns the current setting of the postfix which will be appended at the end of each header postfix in the exported report.
abstract String getHeaderPrefix()
Returns the current setting of the prefix which will be prepended at the beginning of each header prefix in the exported report.
abstract String getLayout()
Returns layout xml.
abstract String getSeparator()
Returns the current setting of the separator which will be used between cells upon calling the export method.
abstract String getValuePostfix()
Returns the current setting of the postfix which will be appended at the end of each metric value in the exported report.
abstract String getValuePrefix()
Returns the current setting of the prefix which will be prepended at the beginning of each metric value in the exported report.
abstract int getVersion()
abstract boolean isShowHeaderAndFooter()
Whether to show the Header and Footer on the exported results.
abstract void setDisplayAttributeForm(boolean displayForm)
Sets whether to display attribute forms in exported reports.
abstract void setHeaderPostfix(String postfix)
Sets the postfix which will be appended at the end of each header cell in the exported report.
abstract void setHeaderPrefix(String prefix)
Sets the prefix which will be prepended at the beginning of each header cell in the exported report.
abstract void setLayout(String xml)
abstract void setSeparator(String separator)
Sets the separator which will be used between cells upon calling the export method.
abstract void setShowHeaderAndFooter(boolean value)
Whether to show the Header and Footer on the exported results.
abstract void setTrimWarehouseData(boolean value)
Whether to trim leading and trailing white space for warehouse element data.
abstract void setValuePostfix(String postfix)
Sets the postfix which will be appended at the end of each metric value in the exported report.
abstract void setValuePrefix(String prefix)
Sets the prefix which will be prepended at the beginning of each metric value in the exported report.
abstract void setVersion(int version)
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebReportExportSettings

Public Methods

public abstract boolean getDisplayAttributeForm ()

Returns the current setting of whether to display attribute forms. By default, this value is true.

Returns
  • Whether attribute forms will be displayed upon exporting.

public abstract String getHeaderPostfix ()

Returns the current setting of the postfix which will be appended at the end of each header postfix in the exported report. By default, this value is an empty string.

Returns
  • The current header postfix setting.

public abstract String getHeaderPrefix ()

Returns the current setting of the prefix which will be prepended at the beginning of each header prefix in the exported report. By default, this value is an empty string.

Returns
  • The current header prefix setting.

public abstract String getLayout ()

Returns layout xml.

Returns
  • layout xml.

public abstract String getSeparator ()

Returns the current setting of the separator which will be used between cells upon calling the export method. By default, this will be a comma(,).

Returns
  • The current separator setting.

public abstract String getValuePostfix ()

Returns the current setting of the postfix which will be appended at the end of each metric value in the exported report. By default, this value is an empty string.

Returns
  • The current value postfix setting.

public abstract String getValuePrefix ()

Returns the current setting of the prefix which will be prepended at the beginning of each metric value in the exported report. By default, this value is an empty string.

Returns
  • The current value postfix setting.

public abstract int getVersion ()

Returns

public abstract boolean isShowHeaderAndFooter ()

Whether to show the Header and Footer on the exported results.
The default value is true.

Returns
  • Whether to show the Header and Footer on the exported results

public abstract void setDisplayAttributeForm (boolean displayForm)

Sets whether to display attribute forms in exported reports. By default, this value is true.

Parameters
displayForm The new setting for whether to display attribute forms.

public abstract void setHeaderPostfix (String postfix)

Sets the postfix which will be appended at the end of each header cell in the exported report.

Parameters
postfix The postfix to add to header cells when exporting.

public abstract void setHeaderPrefix (String prefix)

Sets the prefix which will be prepended at the beginning of each header cell in the exported report.

Parameters
prefix The prefix to add to header cells when exporting.

public abstract void setLayout (String xml)

Parameters
xml the layout xml - use WebReportPlainTextLayoutBuilder to construct it

public abstract void setSeparator (String separator)

Sets the separator which will be used between cells upon calling the export method. By default, this will be a comma(,).

Parameters
separator A string describing the separator to use between cells of an exported report.

public abstract void setShowHeaderAndFooter (boolean value)

Whether to show the Header and Footer on the exported results.
The default value is true.

Parameters
value Whether to show the Header and Footer on the exported results

public abstract void setTrimWarehouseData (boolean value)

Whether to trim leading and trailing white space for warehouse element data. Also controlled by preference WebPreferenceTrimWarehouseData
Setting this overwrites the preference value.

Parameters
value Whether to trim leading and trailing white space for warehouse element data

public abstract void setValuePostfix (String postfix)

Sets the postfix which will be appended at the end of each metric value in the exported report. By default, no prefix will be appended to each metric value.

Parameters
postfix The postfix to add to metric values upon exporting.

public abstract void setValuePrefix (String prefix)

Sets the prefix which will be prepended at the beginning of each metric value in the exported report. By default, no prefix will be prepended to each metric value.

Parameters
prefix The prefix to add to metric values upon exporting.

public abstract void setVersion (int version)

Parameters
version Excel version as defined in EnumExcelVersion