Package com.microstrategy.web.app.transforms

Class FolderPathRenderHelper

java.lang.Object

com.microstrategy.web.app.transforms.FolderPathRenderHelper

public class FolderPathRenderHelper
extends java.lang.Object

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.

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors

Constructor	Description
FolderPathRenderHelper()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getSpecialFolderName(WebFolder folder, AppContext context, boolean isFolderRoot, java.lang.String projectName)	Check for special folders, if found one, return the descriptor.
static boolean	isHiddenFolder(WebFolder folder, java.lang.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(java.lang.String folderName, AppContext context, boolean isFolderRoot)	Look up the type of the folder based on the folder name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderPathRenderHelper

public FolderPathRenderHelper()

Method Detail

isHiddenFolder

public static boolean isHiddenFolder(WebFolder folder,
                                     java.lang.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.

isShowFolderName

public static boolean isShowFolderName(WebFolder folder)

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

Parameters:

folder -

Returns:

Indicate the folder name can be shown

isShowFolderLink

public static boolean isShowFolderLink(WebFolder folder)

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

Parameters:

folder -

Returns:

Indicate if the folder can be shown as a link

getSpecialFolderName

public static java.lang.String getSpecialFolderName(WebFolder folder,
                                                    AppContext context,
                                                    boolean isFolderRoot,
                                                    java.lang.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.

lookupFolderType

public static int lookupFolderType(java.lang.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