Package com.microstrategy.web.app.transforms

Class DataExplorerTransform

    • Field Detail

      • INCREMENTAL_FETCH_PREVIOUS

        protected static final int INCREMENTAL_FETCH_PREVIOUS
        See Also:
        Constant Field Values

      • INCREMENTAL_FETCH_NEXT

        protected static final int INCREMENTAL_FETCH_NEXT
        See Also:
        Constant Field Values

      • tree

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

      • renderForm

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

      • checkImage

        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

      • levelChangeJS

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

      • contextID

        public FormalParameter contextID
        Formal parameter: The context for the object browser fodler links

      • incrementalFetchPageBlock

        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.

      • FP_INCREMENTAL_FETCH_NAV_TYPE

        public static final java.lang.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.
        See Also:
        Constant Field Values

      • FP_INCREMENTAL_FETCH_PAGE_BLOCK

        public static final java.lang.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.
        See Also:
        Constant Field Values

    • Constructor Detail

      • DataExplorerTransform

        public DataExplorerTransform()

    • Method Detail

      • initializeTransform

        public void initializeTransform​(Transformable data)
        Description copied from class: AbstractAppTransform

        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.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractAppTransform
        Parameters:
        data - the bean to transform.

      • initializeCss

        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.
        Overrides:
        initializeCss in class AbstractAppTransform

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Returns:
        The textual description of the transform.

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Get the class of objects this transform is able to handle.
        Specified by:
        getSupportedBeanType in interface Transform
        Overrides:
        getSupportedBeanType in class AbstractAppTransform
        Returns:
        a Class instance with the information about the beans this transform is able to manipulate.

      • renderHiddenInputs

        public void renderHiddenInputs​(MarkupOutput out)
        Renders hidden input tags for each of the events as a part of a form.
        Parameters:
        out - MarkupOutput

      • getForm

        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

      • getHiddenInputsEventList

        protected java.util.ArrayList getHiddenInputsEventList()
        Returns the list of events that will be included in the hidden inputs section.
        Returns:
        ArrayList

      • renderDisplayFormatIcon

        public void renderDisplayFormatIcon​(MarkupOutput out)
        Renders a link to change the display format of the object browser content
        Parameters:
        out - MarkupOutput

      • getGoToEvent

        public WebEvent getGoToEvent()
        Returns the browse event associated with the DataExplorer Browser.
        Returns:
        WebEvent

      • getGoToArgument

        public int getGoToArgument()
        Returns the block begin parameter to be used in data explorer browsing.
        Returns:
        Integer

      • getBrowseEvent

        protected WebEvent getBrowseEvent()
        Returns the browse event associated with the DataExplorer Browser.
        Returns:
        WebEvent

      • getBrowseWithPathEvent

        protected WebEvent getBrowseWithPathEvent()
        Returns the Data Explorer's browse with path event.
        Returns:
        WebEvent

      • getSearchEvent

        protected WebEvent getSearchEvent()
        Returns the WebEvent associated with the DataExplorer's Search.
        Returns:
        WebEvent

      • getChangeDisplayFormatEvent

        protected WebEvent getChangeDisplayFormatEvent()
        Returns a new instance of the event use to toggle the display format
        Returns:
        WebEvent

      • getEvent

        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:
        WebEvent

      • getTreeNodeEvent

        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.
        includeCurrent -
        Returns:
        WebEvent

      • renderList

        public void renderList​(MarkupOutput out)
        Renders the DataExplorer in it's list format.
        Parameters:
        out - MarkupOutput

      • renderLayeredIconInfo

        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.

      • getUnitAttributes

        public java.util.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

      • getCssName

        protected java.lang.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

      • getImageName

        protected java.lang.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

      • getImageTooltip

        protected java.lang.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

      • renderNameInfo

        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.

      • getDisplayUnitName

        public java.lang.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

      • renderAncestorsSelector

        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

      • getFolderLinkList

        public java.util.ArrayList getFolderLinkList()

      • renderFolderLinkOptions

        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

      • renderOpenParentLink

        public void renderOpenParentLink​(MarkupOutput out)

      • renderSearchSection

        public void renderSearchSection​(MarkupOutput out)
        Renders a text box which allows the user to perform a search on the Data Explorer.
        Parameters:
        out - MarkupOutput

      • renderSearchButton

        public void renderSearchButton​(MarkupOutput out)
        Renders a Magnifier image as the search/filter button of the browser
        Parameters:
        out - MarkupOutput

      • renderSearchBox

        public void renderSearchBox​(MarkupOutput out)
        Renders the search box for the project browser
        Parameters:
        out - MarkupOutput

      • isSearchDefined

        protected boolean isSearchDefined()

      • getSearchObject

        protected WebSearch getSearchObject()

      • getSearchPatternArgument

        protected java.lang.String getSearchPatternArgument​(WebEvent searchEvent)

      • getSearchCSSClassName

        protected java.lang.String getSearchCSSClassName()

      • getIncrementalFetchComponent

        protected IncrementalFetch getIncrementalFetchComponent()

      • renderIncrementalFetch

        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

      • getBlockPosition

        protected int getBlockPosition()

      • getBlockSize

        protected int getBlockSize()

      • getChildCount

        protected int getChildCount()

      • renderObjectCount

        public void renderObjectCount​(MarkupOutput out)
        Renders the number of objects currently being displayed on the Data Explorer.
        Parameters:
        out - MarkupOutput

      • isRenderAsTree

        protected boolean isRenderAsTree()

      • generateIncrementalFetchNode

        protected TreeNode generateIncrementalFetchNode​(int direction)

      • createNewNode

        protected TreeNode createNewNode​(java.lang.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:
        TreeNode

      • newTreeNode

        protected TreeNode newTreeNode​(WebDisplayUnit object)
        Creates and populates a single tree node