AggregatedWebFeatures

Class Overview

MicroStrategy Web provides out of the box just a finite number of features based on its own requirements. The features that are resolved by beans in the SDK layer are listed in the EnumWebFeatures enumeration.

Clearly it’s not possible for the application to provide a feature for every different value that can be checked through the SDK, so we provide customers the ability to aggregate their own features to those already been checked by any WebComponent in the application.

To do this, customers need only to create a new class that extends this AggregatedWebFeatures abstract class. The only method that needs to be implemented is the resolveCustomFeature(String) that receives the featureId to check.

The class also provides a getWebComponent() method that returns the corresponding WebComponent associated with this feature (if any). The resolveCustomFeature method can query this object to determine if the feature must be enabled or not.

public class MyFeatures extends AggregatedWebFeatures { private static String REPORT_NAME = "f. Page-by"; public boolean resolveCustomFeature(String featureId) { boolean __result = true; if ("CustomFeature".equals(featureId)) { // // @todo: DO YOUR ONE CHECK HERE! // // In this scenario, we assume that the associated web-component // is a ReportBean and we return true only if the object-name // is a pre-defined value: // if (getWebComponent() instanceof ReportBean) { String reportName = ((ReportBean) getWebComponent()).getObjectName(); __result = REPORT_NAME.equals(reportName); } else { __result = false; } } return __result; } }

To associate this class to a particular bean, invoke the aggregateFeatures(WebComponent) method of the new class (inherited from this classAggregatedWebFeatures), this method expects as an argument the WebComponent to whom WebFeatures will be associated. You can call this method in Microstrategy Web using an add-on. For example:

public class MyFeaturesAddOn extends AbstractAppAddOn { public void preCollectData(WebComponent page) { ReportBean rb = page.getChildByClass(ReportBean.class); if (rb != null) { MyFeatures custom = new MyFeatures(); custom.aggregateFeatures(rb); } } }

Summary

[Expand] Inherited Fields
From class com.microstrategy.web.beans.AbstractWebFeatures protected WebComponent _wc A WebComponent object from which to get more information.

[Expand] Inherited Methods
From class com.microstrategy.web.beans.AbstractWebFeatures boolean checkUserPrivilege(int userPrivilege) Checks whether the userPrivilege passed in granted for the current session void flushCache() Flushes the internal cache where resolved values of features are stored. WebSessionInfo getSession() boolean isFeatureAvailable(String feature, Object dependencyObject) Checks whether the feature that is passed in is supported boolean isFeatureAvailable(String feature) Checks whether the feature that is passed in is supported abstract boolean resolveFeature(String feature) Derived classes are expected to implement this method to indicate whether the feature is supported
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.microstrategy.web.objects.WebFeatures abstract boolean isFeatureAvailable(String feature, Object dependencyObject) Returns whether the given feature is available or not. abstract boolean isFeatureAvailable(String feature) Returns whether the given feature is available or not.