public class

FolderSearchResultsXHTMLTransform

extends FolderViewTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFolderTransform
             ↳ com.microstrategy.web.app.transforms.FolderViewTransform
               ↳ com.microstrategy.web.app.transforms.FolderSearchResultsXHTMLTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This class extends the FolderViewTransform by rendering specific messages related to search results.
Since the results of a search are returned as a folder, this transform shows the messages when the maximum object count is reached, or when the search returns no results.
The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderSearchResultsXHTMLTransform()
Public Methods
Map addSummaryAttribute()
Return the Summary Attribute to be used in the table for the transform.
WebEvent getEvent(WebObjectInfo object)
Extends the parent method by changing the event of the folder bean to make sure it uses browse folder event, as well as for processing the shortcuts.
void renderEmptyList(MarkupOutput out, WebFolder folder)
This method is deprecated. please use and customize renderEmptyList(MarkupOutput) instead, this method won't be called by future releases.
void renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated. please use and customize renderList(MarkupOutput) instead since this method will not be called by future releases.
void renderSearchResultsCount(MarkupOutput out)
Get the HTML to be displayed which includes the number of elements found
void renderSearchResultsCount(MarkupOutput out, WebSearch search)
Get the HTML to be displayed which includes the number of elements found
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided
WebEvent getAdvancedSearchEvent(WebSearch search)
Get the WebEvent for obtaining the advanced search interface.
boolean isObjectVisible(WebObjectInfo object)
Utility method that checks if the object should be displayed or not, based on the information provided on the maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public FolderSearchResultsXHTMLTransform ()

Public Methods

public Map addSummaryAttribute ()

Return the Summary Attribute to be used in the table for the transform.

Returns
  • java.util.Map with the attribute name (as key) and the value.

public WebEvent getEvent (WebObjectInfo object)

Extends the parent method by changing the event of the folder bean to make sure it uses browse folder event, as well as for processing the shortcuts.

Parameters
object a WebObjectInfo for which the event must be retrieved.
Returns
  • the WebEvent associated with browsing folders for the objects of type DssXmlTypeFolder. For any other object types, returns what the parent class would obtain. If the application does not support the event, returns null.

public void renderEmptyList (MarkupOutput out, WebFolder folder)

This method is deprecated.
please use and customize renderEmptyList(MarkupOutput) instead, this method won't be called by future releases.

Get the HTML to display when the folder does not have any contents to be rendered. Overwrites the parent method by showing a message indicating that the search returned no objects and some tips on how to extend the search.

Parameters
out MarkupOutput instance where the transform's output will be saved.
folder the WebFolder instance from the FolderBean being transformed.

public void renderList (MarkupOutput out, WebDisplayUnits list)

This method is deprecated.
please use and customize renderList(MarkupOutput) instead since this method will not be called by future releases.

Overwrites the parent method by adding a message about the count of objects and for adding a summary descriptor (localized string for This table displays the objects result of your search) for the global table that will hold the results.

Parameters
out MarkupOutput instance where the transform's output will be saved.
list WebDisplayUnits instance to be rendered

public void renderSearchResultsCount (MarkupOutput out)

Get the HTML to be displayed which includes the number of elements found

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderSearchResultsCount (MarkupOutput out, WebSearch search)

Get the HTML to be displayed which includes the number of elements found

Parameters
out MarkupOutput instance where the transform's output will be saved.
search the WebSearch instance with the results of the search.

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Parameters
event WebEvent instance from where the anchor information is to be initialized.
Returns

protected WebEvent getAdvancedSearchEvent (WebSearch search)

Get the WebEvent for obtaining the advanced search interface.

Parameters
search WebSearch instance currently used
Returns
  • a WebEvent instance initialized with the event, or null if the application doesn't support it.

protected boolean isObjectVisible (WebObjectInfo object)

Utility method that checks if the object should be displayed or not, based on the information provided on the maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already

Parameters
object WebObjectInfo with the object to check for.
Returns
  • True if the object should be displayed, otherwise returns False