public abstract class

AbstractObjectBrowserTabTransform

extends AbstractEditorTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This transform is the base class for those Tabs that are displayed within an ObjectBrowserManager.

Summary

Constants
String FP_ATTRIBUTE_FORM_IMAGE Constant specifying the name of the formal parameter for defining the attribute form image.
String FP_ATTRIBUTE_IMAGE Constant specifying the name of the formal parameter for defining the attribute image.
String FP_CONSOLIDATION_IMAGE Constant specifying the name of the formal parameter for defining the consolidation image.
String FP_CUBE_IMAGE Constant specifying the name of the formal parameter for defining the cube image.
String FP_CUSTOM_GROUP_IMAGE Constant specifying the name of the formal parameter for defining the custom group image.
String FP_DERIVED_METRIC_IMAGE Constant specifying the name of the formal parameter for defining the derived metric image.
String FP_FILTER_IMAGE Constant specifying the name of the formal parameter for defining the filter image.
String FP_FOLDER_IMAGE Constant specifying the name of the formal parameter for defining the folder image.
String FP_GRAPH_IMAGE Constant specifying the name of the formal parameter for defining the report image.
String FP_GRID_GRAPH_IMAGE Constant specifying the name of the formal parameter for defining the report image.
String FP_HIERARCHY_IMAGE Constant specifying the name of the formal parameter for defining the hierarchy image.
String FP_INCLUDE_DYNAMIC_SCRIPT Constant specifying the name of the formal parameter for specifying whether to include dynamic scripts or not.
String FP_METRIC_DMX_IMAGE Constant specifying the name of the formal parameter for defining the derived metric image.
String FP_METRIC_IMAGE Constant specifying the name of the formal parameter for defining the metric image.
String FP_OBJECT_SUBTYPES_FILTER Constant specifying the name of the formal parameter for defining the object subtypes to consider for the filter.
String FP_OBJECT_TYPES_FILTER Constant specifying the name of the formal parameter for defining the object types to consider for the filter.
String FP_PROMPT_IMAGE Constant specifying the name of the formal parameter for defining the prompt image.
String FP_RA_IMAGE Constant specifying the name of the formal parameter for defining the recursive attribute image.
String FP_REPORT_IMAGE Constant specifying the name of the formal parameter for defining the report image.
String sSpaces
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String _imgAttribute
protected String _imgAttributeForm
protected String _imgConsolidation
protected String _imgCube
protected String _imgCustomGroup
protected String _imgDerivedMetric
protected String _imgFilter
protected String _imgFolder
protected String _imgGraph
protected String _imgGridGraph
protected String _imgHierarchy
protected String _imgMetric
protected String _imgMetricDmx
protected String _imgPrompt
protected String _imgRa
protected String _imgReport
public FormalParameter attributeFormImage Indicates the image to use when displaying an attribute form.
public FormalParameter attributeImage Indicates the image to use when displaying an attribute.
public FormalParameter consolidationImage Indicates the image to use when displaying a consolidation.
public FormalParameter cubeImage Indicates the image to use when displaying a cube.
public FormalParameter customGroupImage Indicates the image to use when displaying a custom group.
public FormalParameter derivedMetricImage Indicates the image to use when displaying a derived metric.
public FormalParameter filterImage Indicates the image to use when displaying a filter.
public FormalParameter folderImage Indicates the image to use when displaying a folder.
public FormalParameter graphImage Indicates the image to use when displaying a graph.
public FormalParameter gridGraphImage Indicates the image to use when displaying a grid and graph.
public FormalParameter hierarchyImage Indicates the image to use when displaying a hierarchy.
public FormalParameter metricDmxImage Indicates the image to use when displaying a Predictive metric.
public FormalParameter metricImage Indicates the image to use when displaying a metric.
public FormalParameter objectSubtypesFilter Indicates the filter specification for the object subtypes that should not be displayed.
public FormalParameter objectTypesFilter Indicates the filter specification for the object types that should not be displayed.
public FormalParameter promptImage Indicates the image to use when displaying a prompt.
public FormalParameter raImage
public FormalParameter reportImage Indicates the image to use when displaying a report.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractObjectBrowserTabTransform()
Default no-argument constructor.
Public Methods
Class getSupportedBeanType()
Returns the supported bean type.
void initializeImages()
Initializes the name of the images to use on this transform's output.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
boolean isTransformEnabled()
Indicates if the transform can be performed for the current state of the bean.
Protected Methods
String formatObjectInfoParameter(String id, String type, String subType, String alias, String name)
Outputs a string formatted the way the objectInfo argument of the event requires it
String generateTooltipInformation(String objectAlias, WebObjectInfo item)
Generates a string that returns the information that would be displayed as a tooltip for the WebObjectInfo item.
String getClassName(WebObjectInfo object)
Return the class name to use for the generation of the HTML tag related with this object.
String getFolderLinkClasses(WebObjectInfo object)
Return the className of the folderLink that is used to render the folder
String getJavascriptTyAttribute(WebObjectInfo object)
Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.
String getObjectDescription(WebObjectInfo item)
Returns the item's description from it's Object Info depending on whether the Allow HTML on object description property has been set.
String getObjectImageName(WebObjectInfo object)
Utility method that helps giving the image name to use - based on the information available on the formal parameters - based on the the object type and/or subtype of the WebObjectInfo instance.
String getTooltipTitle(WebObjectInfo item)
This method returns the tooltip title to be displayed on each object.
void initEditor(Editor editor)
Initialize the editor with the global settings.
boolean isObjectSubtypeVisible(WebObjectInfo object)
Is a validation method to check if the object's type is visible.
boolean isObjectTypeVisible(WebObjectInfo object)
Is a validation method to check if the object's type is visible.
boolean shouldDisplayObject(WebObjectInfo obj)
Returns a boolean value if the user has enough ACLS and privileges to display the object.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_ATTRIBUTE_FORM_IMAGE

Constant specifying the name of the formal parameter for defining the attribute form image. Value is attributeFormImage.

Constant Value: "attributeFormImage"

public static final String FP_ATTRIBUTE_IMAGE

Constant specifying the name of the formal parameter for defining the attribute image. Value is attributeImage.

Constant Value: "attributeImage"

public static final String FP_CONSOLIDATION_IMAGE

Constant specifying the name of the formal parameter for defining the consolidation image. Value is consolidationImage.

Constant Value: "consolidationImage"

public static final String FP_CUBE_IMAGE

Constant specifying the name of the formal parameter for defining the cube image. Value is cubeImage.

Constant Value: "cubeImage"

public static final String FP_CUSTOM_GROUP_IMAGE

Constant specifying the name of the formal parameter for defining the custom group image. Value is customGroupImage.

Constant Value: "customGroupImage"

public static final String FP_DERIVED_METRIC_IMAGE

Constant specifying the name of the formal parameter for defining the derived metric image. Value is derivedMetricImage.

Constant Value: "derivedMetricImage"

public static final String FP_FILTER_IMAGE

Constant specifying the name of the formal parameter for defining the filter image. Value is filterImage.

Constant Value: "filterImage"

public static final String FP_FOLDER_IMAGE

Constant specifying the name of the formal parameter for defining the folder image. Value is folderImage.

Constant Value: "folderImage"

public static final String FP_GRAPH_IMAGE

Constant specifying the name of the formal parameter for defining the report image. Value is graphImage.

Constant Value: "graphImage"

public static final String FP_GRID_GRAPH_IMAGE

Constant specifying the name of the formal parameter for defining the report image. Value is gridGraphImage.

Constant Value: "gridGraphImage"

public static final String FP_HIERARCHY_IMAGE

Constant specifying the name of the formal parameter for defining the hierarchy image. Value is hierarchyImage.

Constant Value: "hierarchyImage"

public static final String FP_INCLUDE_DYNAMIC_SCRIPT

Constant specifying the name of the formal parameter for specifying whether to include dynamic scripts or not. Value is includeDynamicScript.

Constant Value: "includeDynamicScript"

public static final String FP_METRIC_DMX_IMAGE

Constant specifying the name of the formal parameter for defining the derived metric image. Value is derivedMetricImage.

Constant Value: "metricDmxImage"

public static final String FP_METRIC_IMAGE

Constant specifying the name of the formal parameter for defining the metric image. Value is metricImage.

Constant Value: "metricImage"

public static final String FP_OBJECT_SUBTYPES_FILTER

Constant specifying the name of the formal parameter for defining the object subtypes to consider for the filter. Value is objectSubtypesFilter.

Constant Value: "objectSubtypesFilter"

public static final String FP_OBJECT_TYPES_FILTER

Constant specifying the name of the formal parameter for defining the object types to consider for the filter. Value is objectTypesFilter.

Constant Value: "objectTypesFilter"

public static final String FP_PROMPT_IMAGE

Constant specifying the name of the formal parameter for defining the prompt image. Value is promptImage.

Constant Value: "promptImage"

public static final String FP_RA_IMAGE

Constant specifying the name of the formal parameter for defining the recursive attribute image. Value is raImage.

Constant Value: "raImage"

public static final String FP_REPORT_IMAGE

Constant specifying the name of the formal parameter for defining the report image. Value is reportImage.

Constant Value: "reportImage"

protected static final String sSpaces

Constant Value: "                                    "

Fields

protected String _imgAttribute

protected String _imgAttributeForm

protected String _imgConsolidation

protected String _imgCube

protected String _imgCustomGroup

protected String _imgDerivedMetric

protected String _imgFilter

protected String _imgFolder

protected String _imgGraph

protected String _imgGridGraph

protected String _imgHierarchy

protected String _imgMetric

protected String _imgMetricDmx

protected String _imgPrompt

protected String _imgRa

protected String _imgReport

public FormalParameter attributeFormImage

Indicates the image to use when displaying an attribute form.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter attributeImage

Indicates the image to use when displaying an attribute.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter consolidationImage

Indicates the image to use when displaying a consolidation.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter cubeImage

Indicates the image to use when displaying a cube.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter customGroupImage

Indicates the image to use when displaying a custom group.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter derivedMetricImage

Indicates the image to use when displaying a derived metric.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter filterImage

Indicates the image to use when displaying a filter.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter folderImage

Indicates the image to use when displaying a folder.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter graphImage

Indicates the image to use when displaying a graph.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter gridGraphImage

Indicates the image to use when displaying a grid and graph.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter hierarchyImage

Indicates the image to use when displaying a hierarchy.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter metricDmxImage

Indicates the image to use when displaying a Predictive metric.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter metricImage

Indicates the image to use when displaying a metric.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter objectSubtypesFilter

Indicates the filter specification for the object subtypes that should not be displayed.
This filter is applied on top of whatever filter used in the bean when obtaining the information. Usage:
The value to specify for this formal parameter should be a list of numeric object subtypes, separated by commas, with the ones that should not be displayed when transforming the bean. For example, "257,769", indicates custom groups (DssXmlSubTypeCustomGroup) and graphs DssXmlSubTypeReportGraph) should not be displayed if found on the collection of objects to display.

public FormalParameter objectTypesFilter

Indicates the filter specification for the object types that should not be displayed.
This filter is applied on top of whatever filter used in the bean when obtaining the information. Usage:
The value to specify for this formal parameter should be a list of numeric object types, separated by commas, with the ones that should not be displayed when transforming the bean. For example, "3,4", indicates reports (DssXmlTypeReportDefinition) and metrics DssXmlTypeMetric) should not be displayed if found on the collection of objects to display.

public FormalParameter promptImage

Indicates the image to use when displaying a prompt.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

public FormalParameter raImage

public FormalParameter reportImage

Indicates the image to use when displaying a report.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

Public Constructors

public AbstractObjectBrowserTabTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports any of the ObjectBrowserTabBean instances

Returns
  • the class of the bean supported by this transform.

public void initializeImages ()

Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. In particular it invokes the initializeJavaScriptAttribute method.

Parameters
data Transformable instance to be transformed.

public boolean isTransformEnabled ()

Indicates if the transform can be performed for the current state of the bean. If there's a case where the bean might be ready but the information it gets does not match what the transform expects, the rendering process might be stopped here. The outcome will be the component not being rendered at all (which can be logged as a warning for future investigation).

Returns
  • True if it's possible to use the transform for rendering the bean. Otherwise, returns False

Protected Methods

protected String formatObjectInfoParameter (String id, String type, String subType, String alias, String name)

Outputs a string formatted the way the objectInfo argument of the event requires it

Parameters
id id of the object
type type of the object
subType subtype of the object (should be null if dealing with the filter event)
alias alias of the object
name name of the object
Returns
  • a String with the following format: ID|Type|Subtype|Alias|Name or

protected String generateTooltipInformation (String objectAlias, WebObjectInfo item)

Generates a string that returns the information that would be displayed as a tooltip for the WebObjectInfo item.

Parameters
objectAlias a String that has an alias to be displayed on the tooltip along with the item's title.
item The WebObjectInfo for which the tooltip information has to be generated.
Returns
  • a String with the object's tooltip information. This includes the Object Name, Alias and a description.

protected String getClassName (WebObjectInfo object)

Return the class name to use for the generation of the HTML tag related with this object.

Parameters
object The WebObjectInfo for which the class name is required
Returns
  • The Class name for that particular object this object. If none is found given the object type, null will be returned.

protected String getFolderLinkClasses (WebObjectInfo object)

Return the className of the folderLink that is used to render the folder

Parameters
object The WebObjectInfo for which class name is requested.
Returns
  • The class name

protected String getJavascriptTyAttribute (WebObjectInfo object)

Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.

Parameters
object The WebObjectInfo for which it's ty attribute name is requested.
Returns
  • The Javascript TY attribute to use for the generation of the HTML tag related with this object. If none is found given the object type, null will be returned.

protected String getObjectDescription (WebObjectInfo item)

Returns the item's description from it's Object Info depending on whether the Allow HTML on object description property has been set.

Parameters
item The WebObjectInfo for which the description is required.
Returns
  • a String with the description of the object.

protected String getObjectImageName (WebObjectInfo object)

Utility method that helps giving the image name to use - based on the information available on the formal parameters - based on the the object type and/or subtype of the WebObjectInfo instance.

Parameters
object The WebObjectInfo for which it's image name is required.
Returns
  • a String with the name of the image associated with the WebObjectInfo. If the type specified on the WebObjectInfo definition does not match the predefined list of styles, it looks then based on the subtype. If still not found, it will return a transparent image.

protected String getTooltipTitle (WebObjectInfo item)

This method returns the tooltip title to be displayed on each object. It is generated based on the type of the object.

Parameters
item The WebObjectInfo based on which the tooltip has to be derived.
Returns
  • A string with the appropriate tooltip.

protected void initEditor (Editor editor)

Initialize the editor with the global settings.

Parameters
editor Editor instance to initialize

protected boolean isObjectSubtypeVisible (WebObjectInfo object)

Is a validation method to check if the object's type is visible.

Parameters
object The WebObjectInfo whose sub-type visibility has to be checked.
Returns
  • True if the object key is found in the hash map of all the filtered sub-types.

protected boolean isObjectTypeVisible (WebObjectInfo object)

Is a validation method to check if the object's type is visible.

Parameters
object The WebObjectInfo whose type visibility has to be checked.
Returns
  • True if the object key is found in the hash map of all the filtered types.

protected boolean shouldDisplayObject (WebObjectInfo obj)

Returns a boolean value if the user has enough ACLS and privileges to display the object.

Returns
  • Whether the user has enough ACLs and privileges to display the object.