public class

DocumentDetailsXHTMLTransform

extends AbstractDocumentTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractDocumentTransform
             ↳ com.microstrategy.web.app.transforms.DocumentDetailsXHTMLTransform

Class Overview

This transform is used to show details of a document. It has details like document name, report path and some other things. It also has details about all the constituent reports in the document.
The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.

Summary

Constants
String FP_DOCUMENT_PATH_STYLE Constant specifying the name of the formal parameter for defining the style to use for rendering the document path information.
String FP_LEVEL_FLAG Constant specifying the name of the formal parameter for defining the level flag.
String FP_REPORT_DETAIL_STYLE Constant specifying the name of the formal parameter for defining the style to use for rendering the child report information.
int LEVEL_ALL Allowed value for the levelFlag formal parameter.
int LEVEL_DESCRIPTION Allowed value for the levelFlag formal parameter.
int LEVEL_DOCUMENT_ID Allowed value for the levelFlag formal parameter.
int LEVEL_MESSAGE_ID Allowed value for the levelFlag formal parameter.
int LEVEL_NAME Allowed value for the levelFlag formal parameter.
int LEVEL_OWNER Allowed value for the levelFlag formal parameter.
int LEVEL_PATH Allowed value for the levelFlag formal parameter.
int LEVEL_SERVER_NAME Allowed value for the levelFlag formal parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter documentPathStyle The name of the style used to show the document path.
public FormalParameter levelFlag Indicates the level of information to use when displaying the document details.
public FormalParameter reportDetailsStyle The name of the style used to show the report details for each of the reports in the document.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractDocumentTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
DocumentDetailsXHTMLTransform()
Default no argument constructor.
Public Methods
boolean canTransform(Transformable data)
Overrides canTransform by returning always true.
String getDescription()
Returns the description of this transform.
Class getSupportedBeanType()
Get the class of objects this transform is able to handle.
WebEvent getWebReexecuteEvent()
Returns the reexecute event Always get the event from the servlet.
void renderChildrenDetails(MarkupOutput out)
Render the detailed children information of the DocumentBean being displayed
void renderDescription(MarkupOutput out)
Render the description information of the DocumentBean being displayed
void renderDocumentID(MarkupOutput out)
Renders the document ID information for the RWBean being transformed.
void renderMessage(MarkupOutput out)
Render the message identifier information of the DocumentBean being displayed
void renderName(MarkupOutput out)
Render the name information of the DocumentBean being displayed
void renderOwner(MarkupOutput out)
Render the owner information of the DocumentBean being displayed
void renderPath(MarkupOutput out)
Render the path information of the DocumentBean being displayed
void renderServerName(MarkupOutput out)
Render the server information where the DocumentBean being displayed is located
void transformForRequestInError(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "Error".
void transformForRequestProcessing(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "processing" (ie the report is still executing).
void transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status which is transformed by this transform is "Successful".
void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)".
Protected Methods
boolean checkLevel(int level)
Check if the level parameter value contains this flag.
WebDocumentMessage getDocumentMessage()
TransformInstance getDocumentPathTransform(DocumentBean db)
This method is deprecated. not used anymore
WebEvent getExecuteEvent(WebDocumentMessage message)
Returns an event to execute the document.
TransformInstance getReportPathTransform(ReportBean rb)
void initializeDocumentMessage()
Obtains the WebDocumentMessage instance out of the DocumentBean being transformed, for initializing the property of this transform.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractDocumentTransform
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
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_DOCUMENT_PATH_STYLE

Constant specifying the name of the formal parameter for defining the style to use for rendering the document path information. Value is documentPathStyle.

Constant Value: "documentPathStyle"

public static final String FP_LEVEL_FLAG

Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.

Constant Value: "levelFlag"

public static final String FP_REPORT_DETAIL_STYLE

Constant specifying the name of the formal parameter for defining the style to use for rendering the child report information. Value is reportDetailsStyle.

Constant Value: "reportDetailsStyle"

public static final int LEVEL_ALL

Allowed value for the levelFlag formal parameter. Convenience flag to indicate all possible LEVEL values.
Value = 0xffffffff

Constant Value: -1 (0xffffffff)

public static final int LEVEL_DESCRIPTION

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's description.
Value = 2

Constant Value: 2 (0x00000002)

public static final int LEVEL_DOCUMENT_ID

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's document identifier information.
Value = 256

Constant Value: 256 (0x00000100)

public static final int LEVEL_MESSAGE_ID

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the object's message identifier information.
Value = 132

Constant Value: 128 (0x00000080)

public static final int LEVEL_NAME

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's name.
Value = 1

Constant Value: 1 (0x00000001)

public static final int LEVEL_OWNER

Allowed value for the levelFlag formal parameter. Specifies that the transform will display object's owner.
Value = 4

Constant Value: 4 (0x00000004)

public static final int LEVEL_PATH

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the path information of where the object is.
Value = 64

Constant Value: 64 (0x00000040)

public static final int LEVEL_SERVER_NAME

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the name of the server where the object is located.
Value = 32

Constant Value: 32 (0x00000020)

Fields

public FormalParameter documentPathStyle

The name of the style used to show the document path.
This style has to be present in the style catalog. This formal parameter has no significance if the formal parameter used to show the document path is set to false.

public FormalParameter levelFlag

Indicates the level of information to use when displaying the document details.
The information may include object name, description, row count, sql details and other information. Multiple fields might be rendered at the same time. For indicating which fields to show, the value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_NAME, LEVEL_DESCRIPTION, LEVEL_OWNER, etc.
Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 7 (1 + 2 + 4). Default value is LEVEL_ALL

public FormalParameter reportDetailsStyle

The name of the style used to show the report details for each of the reports in the document.
This style has to be present in the style catalog and it must be able to transform a report bean. It also has to match one of the styles specified in the page config file for this page.

Public Constructors

public DocumentDetailsXHTMLTransform ()

Default no argument constructor.

Public Methods

public boolean canTransform (Transformable data)

Overrides canTransform by returning always true. This transform does support showing report details, even if still waiting for prompts.

Parameters
data the bean that will be transformed.
Returns
  • true if the data is a supported bean for this transform (if they are of DocumentBean type).

public String getDescription ()

Returns the description of this transform.
This is used in the style catalog editor.

Returns
  • The description of this transform.

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 getWebReexecuteEvent ()

Returns the reexecute event Always get the event from the servlet.

Returns
  • the web reexecute event

public void renderChildrenDetails (MarkupOutput out)

Render the detailed children information of the DocumentBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderDescription (MarkupOutput out)

Render the description information of the DocumentBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderDocumentID (MarkupOutput out)

Renders the document ID information for the RWBean being transformed.

Parameters
out MarkupOutput

public void renderMessage (MarkupOutput out)

Render the message identifier information of the DocumentBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderName (MarkupOutput out)

Render the name information of the DocumentBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderOwner (MarkupOutput out)

Render the owner information of the DocumentBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderPath (MarkupOutput out)

Render the path information of the DocumentBean being displayed

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void renderServerName (MarkupOutput out)

Render the server information where the DocumentBean being displayed is located

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void transformForRequestInError (MarkupOutput out)

Transform when the bean status which is transformed by this transform is in "Error".

Parameters
out Output by this transform

public void transformForRequestProcessing (MarkupOutput out)

Transform when the bean status which is transformed by this transform is in "processing" (ie the report is still executing).
Just forwards to the successful transform;

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the bean status which is transformed by this transform is "Successful".

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Transform when the bean status which is transformed by this transform is in "waiting for user input (prompts)". Just forwards to the successfull transform;

Parameters
out Output by this transform

Protected Methods

protected boolean checkLevel (int level)

Check if the level parameter value contains this flag. This method calls checkLevel(FormalParameter, int) using the levelFlag parameter

Parameters
level flag value to check
Returns
  • true means the level flag is included in the levelFlag formal parameter value

protected WebDocumentMessage getDocumentMessage ()

Returns

protected TransformInstance getDocumentPathTransform (DocumentBean db)

This method is deprecated.
not used anymore

protected WebEvent getExecuteEvent (WebDocumentMessage message)

Returns an event to execute the document.

Parameters
message the (@link WebDocumentMessage} for the DocumentBean beings displayed.
Returns

protected TransformInstance getReportPathTransform (ReportBean rb)

protected void initializeDocumentMessage ()

Obtains the WebDocumentMessage instance out of the DocumentBean being transformed, for initializing the property of this transform.

Throws
WebBeanException} if any error happens while initializing the information
WebObjectsException} if any error happens while initializing the information
WebBeanException
WebObjectsException