Package com.microstrategy.web.app.transforms

Class DocumentDetailsXHTMLTransform

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

All Implemented Interfaces:

AppTransform, Transform

public class DocumentDetailsXHTMLTransform
extends AbstractDocumentTransform

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.

Since:

MicroStrategy Web 8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
FormalParameter	documentPathStyle	The name of the style used to show the document path.
static java.lang.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.
static java.lang.String	FP_LEVEL_FLAG	Constant specifying the name of the formal parameter for defining the level flag.
static java.lang.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.
static int	LEVEL_ALL	Allowed value for the levelFlag formal parameter.
static int	LEVEL_DESCRIPTION	Allowed value for the levelFlag formal parameter.
static int	LEVEL_DOCUMENT_ID	Allowed value for the levelFlag formal parameter.
static int	LEVEL_MESSAGE_ID	Allowed value for the levelFlag formal parameter.
static int	LEVEL_NAME	Allowed value for the levelFlag formal parameter.
static int	LEVEL_OWNER	Allowed value for the levelFlag formal parameter.
static int	LEVEL_PATH	Allowed value for the levelFlag formal parameter.
static int	LEVEL_SERVER_NAME	Allowed value for the levelFlag formal parameter.
FormalParameter	levelFlag	Indicates the level of information to use when displaying the document details.
FormalParameter	reportDetailsStyle	The name of the style used to show the report details for each of the reports in the document.

Fields inherited from class com.microstrategy.web.app.transforms.AbstractDocumentTransform

imgError

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
DocumentDetailsXHTMLTransform()	Default no argument constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canTransform(Transformable data)	Overrides canTransform by returning always true.
protected boolean	checkLevel(int level)	Check if the level parameter value contains this flag.
java.lang.String	getDescription()	Returns the description of this transform.
protected WebDocumentMessage	getDocumentMessage()
protected TransformInstance	getDocumentPathTransform(DocumentBean db)	Deprecated. not used anymore
protected WebEvent	getExecuteEvent(WebDocumentMessage message)	Returns an event to execute the document.
protected TransformInstance	getReportPathTransform(ReportBean rb)
java.lang.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.
protected void	initializeDocumentMessage()	Obtains the WebDocumentMessage instance out of the DocumentBean being transformed, for initializing the property of this transform.
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)".

Methods inherited from class com.microstrategy.web.app.transforms.AbstractDocumentTransform

getCancelEvent, getContinueEvent, getDocumentBean, getDocumentStatus, getErrorMessage, getErrorMessageFromMSTRDocumentException, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, initializeImages, initializeTransform, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, setWebReexecuteEventArguments, transformForRequestNotInited

Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform

generateErrorForIframe, getReexcuteEventFromBean, getTaskProcessorBaseURL, renderJobExpiredSection

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.transform.Transform

getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

LEVEL_NAME

public static final int LEVEL_NAME

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

See Also:

Constant Field Values

LEVEL_DESCRIPTION

public static final int LEVEL_DESCRIPTION

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

See Also:

Constant Field Values

LEVEL_OWNER

public static final int LEVEL_OWNER

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

See Also:

Constant Field Values

LEVEL_SERVER_NAME

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

See Also:

Constant Field Values

LEVEL_PATH

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

See Also:

Constant Field Values

LEVEL_MESSAGE_ID

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

See Also:

Constant Field Values

LEVEL_DOCUMENT_ID

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

See Also:

Constant Field Values

LEVEL_ALL

public static final int LEVEL_ALL

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

See Also:

Constant Field Values

FP_LEVEL_FLAG

public static final java.lang.String FP_LEVEL_FLAG

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

See Also:

Constant Field Values

FP_REPORT_DETAIL_STYLE

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

See Also:

Constant Field Values

FP_DOCUMENT_PATH_STYLE

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

See Also:

Constant Field Values

levelFlag

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

reportDetailsStyle

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.

documentPathStyle

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.

Constructor Detail

DocumentDetailsXHTMLTransform

public DocumentDetailsXHTMLTransform()

Default no argument constructor.

Method Detail

getDocumentMessage

protected WebDocumentMessage getDocumentMessage()

Returns:

WebDocumentMessage instance of the DocumentBean being transformed.

initializeDocumentMessage

protected void initializeDocumentMessage()
                                  throws WebBeanException,
                                         WebObjectsException

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

Throws:

WebBeanException

WebObjectsException

transformForRequestInError

public void transformForRequestInError(MarkupOutput out)

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

Overrides:

transformForRequestInError in class AbstractDocumentTransform

Parameters:

out - Output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

transformForRequestWaitingForUserInput

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;

Overrides:

transformForRequestWaitingForUserInput in class AbstractAppTransform

Parameters:

out - Output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

transformForRequestProcessing

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;

Overrides:

transformForRequestProcessing in class AbstractAppTransform

Parameters:

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

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

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

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

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

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

checkLevel

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

renderDescription

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.

renderOwner

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.

renderName

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.

renderServerName

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.

renderDocumentID

public void renderDocumentID(MarkupOutput out)

Renders the document ID information for the RWBean being transformed.

Parameters:

out - MarkupOutput

getDocumentPathTransform

protected TransformInstance getDocumentPathTransform(DocumentBean db)

Deprecated.

not used anymore

renderPath

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.

renderMessage

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.

getReportPathTransform

protected TransformInstance getReportPathTransform(ReportBean rb)

renderChildrenDetails

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.

getExecuteEvent

protected WebEvent getExecuteEvent(WebDocumentMessage message)

Returns an event to execute the document.

Parameters:

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

Returns:

a WebEvent instance to execute the document message. By default it returns the EnumDocumentBeanEvents.DOCUMENT_EVENT_EXECUTE_DOCUMENT event, or null if it is not supported by the application

canTransform

public boolean canTransform(Transformable data)

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

Specified by:

canTransform in interface Transform

Overrides:

canTransform in class AbstractDocumentTransform

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).

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 AbstractDocumentTransform

Returns:

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

getDescription

public java.lang.String getDescription()

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

Returns:

The description of this transform.

getWebReexecuteEvent

public WebEvent getWebReexecuteEvent()

Description copied from class: AbstractWebBeanTransform

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

Overrides:

getWebReexecuteEvent in class AbstractDocumentTransform

Returns:

the web reexecute event

Since:

MicroStrategy Web 8.0.1