public abstract class

ReportPreferencePropertyListMapper

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.beans.ReportPreferencePropertyListMapper
Known Direct Subclasses

Class Overview

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.

Summary

Nested Classes
class ReportPreferencePropertyListMapper.AttFormsReportProperty

Title: AttFormsReportProperty

Description: Class that represents the attribute forms report property. 

class ReportPreferencePropertyListMapper.BooleanReportProperty

Title: BooleanReportProperty

Description: Class that represents a special type of ReportPreferencePropertyListMapper.ReportProperty whose value is boolean. 

class ReportPreferencePropertyListMapper.GraphFormatReportProperty

Title: GraphFormatReportProperty

Description: Class that represents the Graph Format report property. 

class ReportPreferencePropertyListMapper.LocalizableReportProperty

Title: LocalizableReportProperty

Description: Class that represents a special type of ReportPreferencePropertyListMapper.ReportProperty that may require localization (i.e margin size)

 
class ReportPreferencePropertyListMapper.PDFPaperSizeReportProperty

Title: PDFPaperSizeReportPropertyPaperSizeReportProperty

Description: Abstract class that represents the PDF Paper Size report property. 

class ReportPreferencePropertyListMapper.PDFScalePagesReportProperty

Title: PDFScalingReportProperty

Description: Class that represents the pdf ScalePagesWide and ScalePagesTall report properties. 

class ReportPreferencePropertyListMapper.PDFScalingReportProperty

Title: PDFScalingReportProperty

Description: Class that represents the pdf scaling report property. 

class ReportPreferencePropertyListMapper.PaperSizeReportProperty

Title: PaperSizeReportProperty

Description: Abstract class that represents the Paper Size report property. 

class ReportPreferencePropertyListMapper.PreferenceOnlyReportProperty

Title: PreferenceOnlyReportProperty

Description: Class that represents a report property that is only a preference. 

class ReportPreferencePropertyListMapper.PrintPaperSizeReportProperty

Title: PrintPaperSizeReportPropertyPaperSizeReportProperty

Description: Abstract class that represents the Print Paper Size report property. 

class ReportPreferencePropertyListMapper.PrintQualityReportProperty

Title: PrintQualityReportProperty

Description: Class that represents the Print Quality report property. 

class ReportPreferencePropertyListMapper.ReadOnlyReportProperty

Title: ReadOnlyReportProperty

Description: This property is only used for reading purposes. 

class ReportPreferencePropertyListMapper.ReportProperty

Title: ReportProperty

Description: Class that represents a report property

 
class ReportPreferencePropertyListMapper.SeparateSheetsReportProperty

Title: SeparateSheetsReportProperty

Description: Class that represents a special type of ReportPreferencePropertyListMapper.ReportProperty for the Use Separate Sheets property. 

Fields
protected RequestKeys _rk
protected boolean _settingsPresent
Public Constructors
ReportPreferencePropertyListMapper(ReportBean rb, RequestKeys rk)
Constructor
ReportPreferencePropertyListMapper(ReportBean rb)
Constructor
Public Methods
String getPreferenceValue(String preferenceName)
Returns the value of a preference/property.
boolean hasReportProperties()
Whether the report contains report properties.
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.
Protected Methods
abstract HashList<String, ReportPreferencePropertyListMapper.ReportProperty> createPropertyList()
Creates a HashList with all the ReportPreferencePropertyListMapper.ReportProperty objects contained on this list
ReportPreferencePropertyListMapper.ReportProperty getPropsPresentReportProperty(String propName, String propSetName)
Returns the ReportPreferencePropertyListMapper.ReportProperty used to determine if the properties have been saved
ReportPreferencePropertyListMapper.ReportProperty getSavePreferencesProperty()
Returns the ReportPreferencePropertyListMapper.ReportProperty used to determine whether to save the preferences
abstract String getSavePreferencesPropertyName()
Returns the name of the property used to determine whether to save the preferences
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected RequestKeys _rk

protected boolean _settingsPresent

Public Constructors

public ReportPreferencePropertyListMapper (ReportBean rb, RequestKeys rk)

Constructor

Parameters
rb The Report Bean
rk The Request Keys

public ReportPreferencePropertyListMapper (ReportBean rb)

Constructor

Parameters
rb The Report Bean

Public Methods

public String getPreferenceValue (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

public boolean hasReportProperties ()

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

Returns
  • Whether the report contains report properties.

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.

Protected Methods

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

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

Returns

protected ReportPreferencePropertyListMapper.ReportProperty getPropsPresentReportProperty (String propName, 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

protected ReportPreferencePropertyListMapper.ReportProperty getSavePreferencesProperty ()

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

Returns

protected abstract 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