public class

FolderPathRenderHelper

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.transforms.FolderPathRenderHelper

Class Overview

This helper class provides some utility methods to render folder paths.

It's shared by ObjectPathTransform, ObjectPathXHTMLTransform and RWDetailsTransform to render the path of ancestor folders.

Summary

Public Constructors
FolderPathRenderHelper()
Public Methods
static String getSpecialFolderName(WebFolder folder, AppContext context, boolean isFolderRoot, String projectName)
Check for special folders, if found one, return the descriptor.
static boolean isHiddenFolder(WebFolder folder, String folderName)

Check to see if a folder is hidden or not.

static boolean isShowFolderLink(WebFolder folder)
Indicate if the folder can be shown as a link check 'browse' and 'read' acl
static boolean isShowFolderName(WebFolder folder)
Indicate the folder name can be shown check 'browser' acl
static int lookupFolderType(String folderName, AppContext context, boolean isFolderRoot)

Look up the type of the folder based on the folder name.

[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FolderPathRenderHelper ()

Public Methods

public static String getSpecialFolderName (WebFolder folder, AppContext context, boolean isFolderRoot, String projectName)

Check for special folders, if found one, return the descriptor. It also checks if the Shared Reports folder, using preferences, has been specified as other folder.

Parameters
folder the folder to check
Returns
  • a String with the descriptor to use if it's a special folder, null otherwise.

public static boolean isHiddenFolder (WebFolder folder, String folderName)

Check to see if a folder is hidden or not.

Parameters
folder the folder to check
folderName the name of the folder
Returns
  • true if the folder is a hidden folder; false otherwise.

public static boolean isShowFolderLink (WebFolder folder)

Indicate if the folder can be shown as a link check 'browse' and 'read' acl

Returns
  • Indicate if the folder can be shown as a link

public static boolean isShowFolderName (WebFolder folder)

Indicate the folder name can be shown check 'browser' acl

Returns
  • Indicate the folder name can be shown

public static int lookupFolderType (String folderName, AppContext context, boolean isFolderRoot)

Look up the type of the folder based on the folder name.

Parameters
folderName the name of the folder to look up against
Returns
  • the type of the folder