public class

DataExplorerTransform

extends AbstractAppTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.DataExplorerTransform

Summary

Nested Classes
class DataExplorerTransform.DisplayUnitContext  
Constants
String FP_CHECK_IMAGE Name for the formal parameter: checkImage
String FP_CONTEXT_ID Name for the formal parameter: contextID
String FP_INCREMENTAL_FETCH_NAV_TYPE Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch.
String FP_INCREMENTAL_FETCH_PAGE_BLOCK Constant specifying the name of the formal parameter for defining the page block size for incremental fetch.
String FP_LEVEL_CHANGE_JS Name for the formal parameter: levelChangeJS
String FP_RENDER_FORM Name for the formal parameter: renderForm
int INCREMENTAL_FETCH_NEXT
int INCREMENTAL_FETCH_PREVIOUS
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter checkImage Formal parameter: The icon to use to submit the parent folders select box in HTML mode.
public FormalParameter contextID Formal parameter: The context for the object browser fodler links
protected FormalParameter incrementalFetchNavigationType Formal parameter that specifies which type of incremental fetch navigation will be enabled.
public FormalParameter incrementalFetchPageBlock Indicates the number of pages to show per block for incremental fetch.
public FormalParameter levelChangeJS Formal parameter: The javascript function to execute when you change the folder level
public FormalParameter renderForm Indicates whether the transform will render it's own HTML form
protected TreeView tree TreeView that is used to render the tree once it's populated
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
DataExplorerTransform()
Public Methods
String getDescription()
String getDisplayUnitName(WebDisplayUnit unit)
Returns the display name of the object being passed in as a parameter.
WebEvent getEvent(WebDisplayUnit unit)
Returns the Data Explorer's browse event associated with the different object types (ex.
ArrayList getFolderLinkList()
int getGoToArgument()
Returns the block begin parameter to be used in data explorer browsing.
WebEvent getGoToEvent()
Returns the browse event associated with the DataExplorer Browser.
Class getSupportedBeanType()
Get the class of objects this transform is able to handle.
WebEvent getTreeNodeEvent(WebDisplayUnit unit, boolean includeCurrent)
Returns the Data Explorer's browse event for Tree Nodes associated with the different object types (ex.
Map getUnitAttributes(WebDisplayUnit unit)
Returns a map of the different HTML attributes that would be added to the HTML tags denoting each item on the Data Explorer.
void initializeCss()
Initializes the Css Classes to use.
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderAncestorsSelector(MarkupOutput out)
Renders a HTML pulldown which contains information of the currently browsed object's ancestors.
void renderBrowser(MarkupOutput out)
Renders the Project Browser based on the information provided by the fodler bean.
void renderBrowserContent(MarkupOutput out)
Renders the Project Browser's elements based on the information provided by the Data Explorer bean.
void renderDisplayFormatIcon(MarkupOutput out)
Renders a link to change the display format of the object browser content
void renderFolderLinkOptions(MarkupOutput out)
Renders shortcuts to predefined Folder Links as HTML option tags in the Data Explorer's ancestor pull down.
void renderHiddenInputs(MarkupOutput out)
Renders hidden input tags for each of the events as a part of a form.
void renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch links for the browse list, including the images.
void renderLayeredIconInfo(MarkupOutput out, WebDisplayUnit unit)
To generate layered icon for attribute item generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).
void renderList(MarkupOutput out)
Renders the DataExplorer in it's list format.
void renderNameInfo(MarkupOutput out, WebDisplayUnit unit)
Renders HTML tags which contain the name and other related information of the object being rendered on the Data Explorer.
void renderObjectCount(MarkupOutput out)
Renders the number of objects currently being displayed on the Data Explorer.
void renderOpenParentLink(MarkupOutput out)
void renderSearchBox(MarkupOutput out)
Renders the search box for the project browser
void renderSearchButton(MarkupOutput out)
Renders a Magnifier image as the search/filter button of the browser
void renderSearchSection(MarkupOutput out)
Renders a text box which allows the user to perform a search on the Data Explorer.
void renderUnit(MarkupOutput out, WebDisplayUnit unit)
Renders an item on the Data Explorer Browser.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
TreeNode createNewNode(Object childObj, boolean isExpanded)
Creates a new tree node with the information about the object.
TreeNode generateIncrementalFetchNode(int direction)
int getBlockPosition()
int getBlockSize()
WebEvent getBrowseEvent()
Returns the browse event associated with the DataExplorer Browser.
WebEvent getBrowseWithPathEvent()
Returns the Data Explorer's browse with path event.
WebEvent getChangeDisplayFormatEvent()
Returns a new instance of the event use to toggle the display format
int getChildCount()
TransformContext getContext()
Returns the instance of TransformContext with context information for this Transform.
String getCssName(WebDisplayUnit unit)
Returns the css class name which helps in getting the image associated with the different object types in the Data Explorer.
Tag getForm(Tag content)
Creates and returns a HTML FORM Tag with the contents and hidden inputs for all the associated events.
ArrayList getHiddenInputsEventList()
Returns the list of events that will be included in the hidden inputs section.
String getImageName(WebDisplayUnit unit)
Returns the image path name which helps in getting the image associated with the different object types in the Data Explorer.
String getImageTooltip(WebDisplayUnit unit)
Returns the image tooltip which helps in getting the image associated with the different object types in the Data Explorer.
IncrementalFetch getIncrementalFetchComponent()
String getSearchCSSClassName()
WebEvent getSearchEvent()
Returns the WebEvent associated with the DataExplorer's Search.
WebSearch getSearchObject()
String getSearchPatternArgument(WebEvent searchEvent)
boolean isRenderAsTree()
boolean isSearchDefined()
TreeNode newTreeNode(WebDisplayUnit object)
Creates and populates a single tree node
void populateTreeNodes(WebDisplayUnits children, TreeNode parentNode)
[Expand]
Inherited Methods
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_CHECK_IMAGE

Name for the formal parameter: checkImage

Constant Value: "checkImage"

public static final String FP_CONTEXT_ID

Name for the formal parameter: contextID

Constant Value: "contextID"

public static final String FP_INCREMENTAL_FETCH_NAV_TYPE

Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch. Value is incrementalFetchNavigationType.

Constant Value: "incrementalFetchNavigationType"

public static final String FP_INCREMENTAL_FETCH_PAGE_BLOCK

Constant specifying the name of the formal parameter for defining the page block size for incremental fetch. Value is incrementalFetchPageBlock.

Constant Value: "incrementalFetchPageBlock"

public static final String FP_LEVEL_CHANGE_JS

Name for the formal parameter: levelChangeJS

Constant Value: "levelChangeJS"

public static final String FP_RENDER_FORM

Name for the formal parameter: renderForm

Constant Value: "renderForm"

protected static final int INCREMENTAL_FETCH_NEXT

Constant Value: 1 (0x00000001)

protected static final int INCREMENTAL_FETCH_PREVIOUS

Constant Value: 0 (0x00000000)

Fields

public FormalParameter checkImage

Formal parameter: The icon to use to submit the parent folders select box in HTML mode. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter contextID

Formal parameter: The context for the object browser fodler links

protected FormalParameter incrementalFetchNavigationType

Formal parameter that specifies which type of incremental fetch navigation will be enabled. Allowed values: a valid bitwise combination of NAVIGATION_BUTTONS_FIRST_LAST and/or NAVIGATION_BUTTONS_PREVIOUS_NEXT

public FormalParameter incrementalFetchPageBlock

Indicates the number of pages to show per block for incremental fetch.
Default value is 5, so the incremental fetch will render the navigation arrows for moving up and down five pages at the time.

public FormalParameter levelChangeJS

Formal parameter: The javascript function to execute when you change the folder level

public FormalParameter renderForm

Indicates whether the transform will render it's own HTML form

protected TreeView tree

TreeView that is used to render the tree once it's populated

Public Constructors

public DataExplorerTransform ()

Public Methods

public String getDescription ()

public String getDisplayUnitName (WebDisplayUnit unit)

Returns the display name of the object being passed in as a parameter.

Parameters
unit WebDisplayUnit whose name has to be retrieved
Returns
  • String

public WebEvent getEvent (WebDisplayUnit unit)

Returns the Data Explorer's browse event associated with the different object types (ex. Attributes, Elements)

Parameters
unit The object who's browse event has to be retrieved.
Returns

public ArrayList getFolderLinkList ()

public int getGoToArgument ()

Returns the block begin parameter to be used in data explorer browsing.

Returns
  • Integer

public WebEvent getGoToEvent ()

Returns the browse event associated with the DataExplorer Browser.

Returns

public Class getSupportedBeanType ()

Get the class of objects this transform is able to handle.

Returns
  • a Class instance with the information about the beans this transform is able to manipulate.

public WebEvent getTreeNodeEvent (WebDisplayUnit unit, boolean includeCurrent)

Returns the Data Explorer's browse event for Tree Nodes associated with the different object types (ex. Attributes, Elements)

Parameters
unit The object who's browse event has to be retrieved.
Returns

public Map getUnitAttributes (WebDisplayUnit unit)

Returns a map of the different HTML attributes that would be added to the HTML tags denoting each item on the Data Explorer. The attributes include information like the type, tooltip information, css classes etc.

Parameters
unit WebDisplayUnit whose information is needed to create the attribute Map
Returns
  • Map

public void initializeCss ()

Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public void renderAncestorsSelector (MarkupOutput out)

Renders a HTML pulldown which contains information of the currently browsed object's ancestors. It will show all the available parents of the currently browsed object in indented format.

Parameters
out MarkupOutput

public void renderBrowser (MarkupOutput out)

Renders the Project Browser based on the information provided by the fodler bean.

Parameters
out MarkupOutput
Throws
WebBeanException
WebObjectsException
WebBeanException

public void renderBrowserContent (MarkupOutput out)

Renders the Project Browser's elements based on the information provided by the Data Explorer bean. This method is called by the renderBrowser method.

Parameters
out MarkupOutput
Throws
WebObjectsException
WebBeanException
WebObjectsException

public void renderDisplayFormatIcon (MarkupOutput out)

Renders a link to change the display format of the object browser content

Parameters
out MarkupOutput

public void renderFolderLinkOptions (MarkupOutput out)

Renders shortcuts to predefined Folder Links as HTML option tags in the Data Explorer's ancestor pull down.

Parameters
out MarkupOutput

public void renderHiddenInputs (MarkupOutput out)

Renders hidden input tags for each of the events as a part of a form.

Parameters
out MarkupOutput

public void renderIncrementalFetch (MarkupOutput out)

Renders the incremental fetch links for the browse list, including the images.

Parameters
out MarkupOutput instance which includes the HTML for the header of the table to be used on the transform

public void renderLayeredIconInfo (MarkupOutput out, WebDisplayUnit unit)

To generate layered icon for attribute item generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).

Parameters
out MarkupOutput instance where to save the contents to display
unit WebDisplayUnit to be rendered.

public void renderList (MarkupOutput out)

Renders the DataExplorer in it's list format.

Parameters
out MarkupOutput

public void renderNameInfo (MarkupOutput out, WebDisplayUnit unit)

Renders HTML tags which contain the name and other related information of the object being rendered on the Data Explorer.

Parameters
out MarkupOutput
unit WebDisplayUnit whose name and other information is being rendered.

public void renderObjectCount (MarkupOutput out)

Renders the number of objects currently being displayed on the Data Explorer.

Parameters
out MarkupOutput

public void renderOpenParentLink (MarkupOutput out)

public void renderSearchBox (MarkupOutput out)

Renders the search box for the project browser

Parameters
out MarkupOutput

public void renderSearchButton (MarkupOutput out)

Renders a Magnifier image as the search/filter button of the browser

Parameters
out MarkupOutput

public void renderSearchSection (MarkupOutput out)

Renders a text box which allows the user to perform a search on the Data Explorer.

Parameters
out MarkupOutput

public void renderUnit (MarkupOutput out, WebDisplayUnit unit)

Renders an item on the Data Explorer Browser.

Parameters
out MarkupOutput
unit a WebDisplayUnit which has to be displayed on the Data Explorer.

public void transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Parameters
out output by this transform

Protected Methods

protected TreeNode createNewNode (Object childObj, boolean isExpanded)

Creates a new tree node with the information about the object. This is called when the Data Explorer is displayed in the tree format.

Parameters
childObj Object whose information is used to create the new tree node.
isExpanded a boolean parameter which tells us whether the newly created node has to be left expanded or collapsed.
Returns

protected TreeNode generateIncrementalFetchNode (int direction)

protected int getBlockPosition ()

protected int getBlockSize ()

protected WebEvent getBrowseEvent ()

Returns the browse event associated with the DataExplorer Browser.

Returns

protected WebEvent getBrowseWithPathEvent ()

Returns the Data Explorer's browse with path event.

Returns

protected WebEvent getChangeDisplayFormatEvent ()

Returns a new instance of the event use to toggle the display format

Returns
  • WebEvent

protected int getChildCount ()

protected TransformContext getContext ()

Returns the instance of TransformContext with context information for this Transform.

protected String getCssName (WebDisplayUnit unit)

Returns the css class name which helps in getting the image associated with the different object types in the Data Explorer.

Parameters
unit WebDisplayUnit whose type has to be checked to retrieve the css class name.
Returns
  • String

protected Tag getForm (Tag content)

Creates and returns a HTML FORM Tag with the contents and hidden inputs for all the associated events.

Parameters
content a Tag with the contents of the form.
Returns
  • a HTML FORM Tag

protected ArrayList getHiddenInputsEventList ()

Returns the list of events that will be included in the hidden inputs section.

Returns
  • ArrayList

protected String getImageName (WebDisplayUnit unit)

Returns the image path name which helps in getting the image associated with the different object types in the Data Explorer.

Parameters
unit WebDisplayUnit whose type has to be checked to retrieve the image path name.
Returns
  • String

protected String getImageTooltip (WebDisplayUnit unit)

Returns the image tooltip which helps in getting the image associated with the different object types in the Data Explorer.

Parameters
unit WebDisplayUnit whose type has to be checked to generate the tooltip information.
Returns
  • String

protected IncrementalFetch getIncrementalFetchComponent ()

protected String getSearchCSSClassName ()

protected WebEvent getSearchEvent ()

Returns the WebEvent associated with the DataExplorer's Search.

Returns

protected WebSearch getSearchObject ()

protected String getSearchPatternArgument (WebEvent searchEvent)

protected boolean isRenderAsTree ()

protected boolean isSearchDefined ()

protected TreeNode newTreeNode (WebDisplayUnit object)

Creates and populates a single tree node

protected void populateTreeNodes (WebDisplayUnits children, TreeNode parentNode)