Package com.microstrategy.web.app.beans

Class ReportPreferencePropertyListMapper

java.lang.Object

com.microstrategy.web.app.beans.ReportPreferencePropertyListMapper

Direct Known Subclasses:

ExportReportPreferencePropertyListMapper, PDFReportPreferencePropertyListMapper, PrintReportPreferencePropertyListMapper

public abstract class ReportPreferencePropertyListMapper
extends java.lang.Object

Helper class to aid on reading and saving Report properties that are also saved as preferences.
The value of a property will be read from: request keys, report property, preference (in this order).
Note: this is used for Exporting, PDF and HTML Printing.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ReportPreferencePropertyListMapper.AttFormsReportProperty	Title: AttFormsReportProperty
protected class	ReportPreferencePropertyListMapper.BooleanReportProperty	Title: BooleanReportProperty
protected class	ReportPreferencePropertyListMapper.GraphFormatReportProperty	Title: GraphFormatReportProperty
protected class	ReportPreferencePropertyListMapper.LocalizableReportProperty	Title: LocalizableReportProperty
protected class	ReportPreferencePropertyListMapper.PaperSizeReportProperty	Title: PaperSizeReportProperty
protected class	ReportPreferencePropertyListMapper.PDFPaperSizeReportProperty	Title: PDFPaperSizeReportPropertyPaperSizeReportProperty
protected class	ReportPreferencePropertyListMapper.PDFScalePagesReportProperty	Title: PDFScalingReportProperty
protected class	ReportPreferencePropertyListMapper.PDFScalingReportProperty	Title: PDFScalingReportProperty
protected class	ReportPreferencePropertyListMapper.PreferenceOnlyReportProperty	Title: PreferenceOnlyReportProperty
protected class	ReportPreferencePropertyListMapper.PrintPaperSizeReportProperty	Title: PrintPaperSizeReportPropertyPaperSizeReportProperty
protected class	ReportPreferencePropertyListMapper.PrintQualityReportProperty	Title: PrintQualityReportProperty
protected class	ReportPreferencePropertyListMapper.ReadOnlyReportProperty	Title: ReadOnlyReportProperty
protected class	ReportPreferencePropertyListMapper.ReportProperty	Title: ReportProperty
protected class	ReportPreferencePropertyListMapper.SeparateSheetsReportProperty	Title: SeparateSheetsReportProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected RequestKeys	_rk
protected boolean	_settingsPresent

Constructor Summary

Constructors

Constructor	Description
ReportPreferencePropertyListMapper(ReportBean rb)	Constructor
ReportPreferencePropertyListMapper(ReportBean rb, RequestKeys rk)	Constructor

Method Summary

Modifier and Type	Method	Description
protected abstract HashList<java.lang.String,ReportPreferencePropertyListMapper.ReportProperty>	createPropertyList()	Creates a HashList with all the ReportPreferencePropertyListMapper.ReportProperty objects contained on this list
java.lang.String	getPreferenceValue(java.lang.String preferenceName)	Returns the value of a preference/property. The value returned is as if it were read from preference (i.e.
protected ReportPreferencePropertyListMapper.ReportProperty	getPropsPresentReportProperty(java.lang.String propName, java.lang.String propSetName)	Returns the ReportPreferencePropertyListMapper.ReportProperty used to determine if the properties have been saved
protected ReportPreferencePropertyListMapper.ReportProperty	getSavePreferencesProperty()	Returns the ReportPreferencePropertyListMapper.ReportProperty used to determine whether to save the preferences
protected abstract java.lang.String	getSavePreferencesPropertyName()	Returns the name of the property used to determine whether to save the preferences
boolean	hasReportProperties()	Whether the report contains report properties. True if property "settingsPresent" is true.
void	saveProperties()	Saves all properties on the list to Report Properties If "savePreferences" is found on the request, the values would be save to preferences.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_rk

protected RequestKeys _rk

_settingsPresent

protected boolean _settingsPresent

Constructor Detail

ReportPreferencePropertyListMapper

public ReportPreferencePropertyListMapper(ReportBean rb,
                                          RequestKeys rk)

Constructor

Parameters:

rb - The Report Bean

rk - The Request Keys

ReportPreferencePropertyListMapper

public ReportPreferencePropertyListMapper(ReportBean rb)

Constructor

Parameters:

rb - The Report Bean

Method Detail

saveProperties

public void saveProperties()

Saves all properties on the list to Report Properties If "savePreferences" is found on the request, the values would be save to preferences.

getPreferenceValue

public java.lang.String getPreferenceValue(java.lang.String preferenceName)

Returns the value of a preference/property.
The value returned is as if it were read from preference (i.e. "1"=true)

Parameters:

preferenceName - The preference name

Returns:

Returns the value of a preference/property

hasReportProperties

public boolean hasReportProperties()

Whether the report contains report properties.
True if property "settingsPresent" is true.

Returns:

Whether the report contains report properties.

createPropertyList

protected abstract HashList<java.lang.String,ReportPreferencePropertyListMapper.ReportProperty> createPropertyList()

Creates a HashList with all the ReportPreferencePropertyListMapper.ReportProperty objects contained on this list

Returns:

a HashList with all the ReportPreferencePropertyListMapper.ReportProperty objects contained on this list

getPropsPresentReportProperty

protected ReportPreferencePropertyListMapper.ReportProperty getPropsPresentReportProperty(java.lang.String propName,
                                                                                          java.lang.String propSetName)

Returns the ReportPreferencePropertyListMapper.ReportProperty used to determine if the properties have been saved

Parameters:

propName - The property name

propSetName - The property set name

Returns:

the ReportPreferencePropertyListMapper.ReportProperty used to determine if the properties have been saved

getSavePreferencesPropertyName

protected abstract java.lang.String getSavePreferencesPropertyName()

Returns the name of the property used to determine whether to save the preferences

Returns:

the name of the property used to determine whether to save the preferences

getSavePreferencesProperty

protected ReportPreferencePropertyListMapper.ReportProperty getSavePreferencesProperty()

Returns the ReportPreferencePropertyListMapper.ReportProperty used to determine whether to save the preferences

Returns:

the ReportPreferencePropertyListMapper.ReportProperty used to determine whether to save the preferences