Package com.microstrategy.web.app.transforms

Class ReportIncrementalFetchTransform

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

com.microstrategy.web.app.transforms.ReportIncrementalFetchTransform

All Implemented Interfaces:

AppTransform, Transform

public class ReportIncrementalFetchTransform
extends AbstractReportTransform

Title: MSTR Web Transform Component: ReportIncrementalFetchTransform Description: Provides report bean a grid view Copyright: Copyright (c) 2001 Company: MicroStrategy

Since:

MicroStrategy Web 7.3.1 or earlier

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
protected FormalParameter	imgFirstArrow	Deprecated. We now use CSS classes to render images.
protected FormalParameter	imgFirstArrowDisabled	Deprecated. We now use CSS classes to render images.
protected FormalParameter	imgLastArrow	Deprecated. We now use CSS classes to render images.
protected FormalParameter	imgLastArrowDisabled	Deprecated. We now use CSS classes to render images.
protected FormalParameter	imgLeftArrow	Deprecated. We now use CSS classes to render images.
protected FormalParameter	imgLeftArrowDisabled	Deprecated. We now use CSS classes to render images.
protected FormalParameter	imgRightArrow	Deprecated. We now use CSS classes to render images.
protected FormalParameter	imgRightArrowDisabled	Deprecated. We now use CSS classes to render images.
protected FormalParameter	increFetchBlockCountOnRow	This is the incremental fetch step on row used in the transform.
protected FormalParameter	increFetchNavigationType	Formal parameter that specifies which type of incremental fetch navigation will be enabled.

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

BLANK_SUBSET_REPORT_ID, BLANK_XDA_REPORT_ID, cssErrorMessage, cssErrorTitle, cssUseFileContent, generateJSForDrillCheckBoxesForIncFetch, iFramePara, imgError, showScroller, useBuiltInFormatPara

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
ReportIncrementalFetchTransform()	default no-args constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Return description for this Transform.
protected IncrementalFetch	getIncrementalFetchComponent()
void	initializeCss()	initialize the css information for the transform.
boolean	shouldDisplayIncrementalFetch()	Test for the conditions required for incremetal fetch to be rendered
void	transformForRequestSuccessful(MarkupOutput mo)	Transform when the report status is "Successful".

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

canTransform, generateAnchor, generateErrorForIframe, generateErrorForIframe, generateIncFetchAnchor, generateIncFetchOpenAnchor, getCancelEvent, getContinueEvent, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getNextColumnsEvent, getPreviousColumnsEvent, getReexecuteButtonDescription, getReportBean, getReportStatus, getReportStatusDescriptorKey, getRepromptEvent, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, initializeImages, initializeProperties, initializeTransform, initializeWebComponent, isCubeReport, isDatamart, isDesignMode, isIFrameEnabled, isIncRefreshReport, isNonViewableReport, renderColumnsIncrementalFetch, renderColumnsIncrementalFetchNext, renderColumnsIncrementalFetchPrevious, renderContinueFormForRequestInError, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderJobExpiredSection, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, useBuiltInFormat

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

getReexcuteEventFromBean, getTaskProcessorBaseURL

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, 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, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, 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, transformForRequestProcessing, transformForRequestWaitingForUserInput

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

increFetchBlockCountOnRow

protected FormalParameter increFetchBlockCountOnRow

This is the incremental fetch step on row used in the transform.
Allowed values: positive integer values

imgFirstArrow

protected FormalParameter imgFirstArrow

Deprecated.

We now use CSS classes to render images.

This is the image name for first arrow used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

imgFirstArrowDisabled

protected FormalParameter imgFirstArrowDisabled

Deprecated.

We now use CSS classes to render images.

This is the image name for disabled first arrow used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

imgLeftArrow

protected FormalParameter imgLeftArrow

Deprecated.

We now use CSS classes to render images.

This is the image name for left arrow used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

imgLeftArrowDisabled

protected FormalParameter imgLeftArrowDisabled

Deprecated.

We now use CSS classes to render images.

This is the image name for disabled left arrow used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

imgRightArrow

protected FormalParameter imgRightArrow

Deprecated.

We now use CSS classes to render images.

This is the image name for right arrow used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

imgRightArrowDisabled

protected FormalParameter imgRightArrowDisabled

Deprecated.

We now use CSS classes to render images.

This is the image name for disabled right arrow used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

imgLastArrow

protected FormalParameter imgLastArrow

Deprecated.

We now use CSS classes to render images.

This is the image name for last arrow used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

imgLastArrowDisabled

protected FormalParameter imgLastArrowDisabled

Deprecated.

We now use CSS classes to render images.

This is the image name for disabled last arrow used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

increFetchNavigationType

protected FormalParameter increFetchNavigationType

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

Since:

MicroStrategy Web 9.0.0

Constructor Detail

ReportIncrementalFetchTransform

public ReportIncrementalFetchTransform()

default no-args constructor.
It created the formal parameters and assign default values to them.

Method Detail

initializeCss

public void initializeCss()

initialize the css information for the transform.

Overrides:

initializeCss in class AbstractAppTransform

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput mo)

Transform when the report status is "Successful".

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

mo - output by this transform

See Also:

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

shouldDisplayIncrementalFetch

public boolean shouldDisplayIncrementalFetch()

Test for the conditions required for incremetal fetch to be rendered

Returns:

true if incremetal fetch is to be rendered.

Since:

MicroStrategy Web 8.0.0

getIncrementalFetchComponent

protected IncrementalFetch getIncrementalFetchComponent()

Since:

MicroStrategy Web 9.0.0

getDescription

public java.lang.String getDescription()

Return description for this Transform.

Returns:

description for this Transform