public
class
RWTransformHelper
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.web.app.transforms.RWTransformHelper |
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| long | TR_ATTRIBUTE | ||||||||||
| long | TR_A_AND_M | ||||||||||
| long | TR_A_AND_NDE | ||||||||||
| long | TR_METRIC | ||||||||||
| long | TR_NDE | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| RWTransformHelper() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static String |
addCSRFIntoURL(String orgURL, String servletPath, ParameterBuilder urlPB)
This method is deprecated.
use
addCSRFIntoURL(String, AppContext)
| ||||||||||
| static String |
addCSRFIntoURL(String url, AppContext appContext)
Add the CSRF token into URL string if needed
| ||||||||||
| static int | getAvailableViewMedia(RWBean rwb) | ||||||||||
| static HashMap<String, Boolean> |
getConflictedNameMap(ArrayList<RWDataSetItem> list)
Returns a HashMap for checking if item name is conflicted in a RWDataSetItem list.
| ||||||||||
| static JsonGenerator | getDatasetsInfos(RWBean rwb) | ||||||||||
| static int | getDefaultViewMediaMode(RWBean rwb) | ||||||||||
| static String | getLayoutName(RWLayoutSectionDef layout, String label) | ||||||||||
| static ArrayList<RWDataSetItem> |
getOrderdRWDataSetItems(RWDataSets dataSets, Locale locale, long typeRestriction)
Returns a list contains ordered RWDataSetItem from all data sets.
| ||||||||||
| static String |
getRWPropertyValue(RWBean rwb, String propertyGroupName, String propertyName, String defaultValue)
Given the group and property specified as parameters, find and return its value according
to the
RWBean object passed as parameter. | ||||||||||
| static String |
getRWPropertyValue(RWBean rwb, String propertyGroupName, String propertyName)
Given the group and property specified as parameters, find and return its value according
to the
RWBean object passed as parameter. | ||||||||||
| static String | getSectionTitle(RWBean rwBean, Messages messages, RWSectionDef sectionDef) | ||||||||||
| static String | getSectionTitle(RWBean rwBean, AbstractAppTransform transform, RWSectionDef sectionDef) | ||||||||||
| static JsonGenerator | getWorkingSetInfos(WebWorkingSet wws, Messages messages) | ||||||||||
| static boolean | isJavascriptInUrlAllowed(String url) | ||||||||||
| static boolean | isOnlyDetailsHeaderVisible(List visibleSections) | ||||||||||
| static boolean | isSingleSourceGrid(RWBean rwb) | ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static void |
redirectToDisplayError(MarkupOutput out, RWBean rwBean, AppContext appContext, EventManager eventManager, String errorMessage)
Since MicroStrategy Web 10.6
This method is used to jump to a new "Error page" to show error messages.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final long TR_ATTRIBUTE
Constant Value:
2
(0x0000000000000002)
public static final long TR_A_AND_M
Constant Value:
3
(0x0000000000000003)
public static final long TR_A_AND_NDE
Constant Value:
6
(0x0000000000000006)
public static final long TR_METRIC
Constant Value:
1
(0x0000000000000001)
public static final long TR_NDE
Constant Value:
4
(0x0000000000000004)
Public Constructors
public RWTransformHelper ()
Public Methods
public static String addCSRFIntoURL (String orgURL, String servletPath, ParameterBuilder urlPB)
This method is deprecated.
use addCSRFIntoURL(String, AppContext)
Add the CSRF token into URL string if needed
Returns
- the URL with CSRF token
public static String addCSRFIntoURL (String url, AppContext appContext)
Add the CSRF token into URL string if needed
Returns
- the URL with CSRF token
public static HashMap<String, Boolean> getConflictedNameMap (ArrayList<RWDataSetItem> list)
Returns a HashMap for checking if item name is conflicted in a RWDataSetItem list.
Parameters
| list | a list contains RWDataSetItem |
|---|
Returns
- a HashMap for checking if item name is conflicted in the list. If item name is conflicted, the value associated with it should be Boolean.TRUE. Otherwise, the value is Boolean.FALSE.
public static JsonGenerator getDatasetsInfos (RWBean rwb)
public static ArrayList<RWDataSetItem> getOrderdRWDataSetItems (RWDataSets dataSets, Locale locale, long typeRestriction)
Returns a list contains ordered RWDataSetItem from all data sets.
These items are grouped by category (Attribute, Metric and User Metric), and then sorted by alphabetical within each category.
The valid restriction type are com.microstrategy.webapi.EnumDSSXMLObjectTypes.DssXmlTypeAttribute and com.microstrategy.webapi.EnumDSSXMLObjectTypes.DssXmlTypeMetric.
Parameters
| dataSets | a data set collection |
|---|---|
| locale | the desired locale used to compare the name of RWDataSetItem |
| typeRestriction | a list of object types. |
Returns
- a list contains the required RWDataSetItem.
public static String getRWPropertyValue (RWBean rwb, String propertyGroupName, String propertyName, String defaultValue)
Given the group and property specified as parameters, find and return its value according
to the RWBean object passed as parameter. If there is any error or the property or
group cannot be found or default is used, the default value passed as parameter will be returned.
Parameters
| rwb | ReportWriter Bean |
|---|---|
| propertyGroupName | the name of the property group to analyze |
| propertyName | the name of the property in the property group to analyze |
| defaultValue | the value to return if anything failed during the process |
Returns
- the property value found for the object requested, or the default value if the process could not be completed
public static String getRWPropertyValue (RWBean rwb, String propertyGroupName, String propertyName)
Given the group and property specified as parameters, find and return its value according
to the RWBean object passed as parameter.
Parameters
| rwb | ReportWriter Bean |
|---|---|
| propertyGroupName | the name of the property group to analyze |
| propertyName | the name of the property in the property group to analyze |
Returns
- the property value found for the object requested
public static String getSectionTitle (RWBean rwBean, AbstractAppTransform transform, RWSectionDef sectionDef)
public static JsonGenerator getWorkingSetInfos (WebWorkingSet wws, Messages messages)
public static boolean isJavascriptInUrlAllowed (String url)
public static boolean isOnlyDetailsHeaderVisible (List visibleSections)
Protected Methods
protected static void redirectToDisplayError (MarkupOutput out, RWBean rwBean, AppContext appContext, EventManager eventManager, String errorMessage)
Since MicroStrategy Web 10.6 This method is used to jump to a new "Error page" to show error messages.