Package com.microstrategy.web.app.transforms

Class RWIncrementalFetchTransform

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

com.microstrategy.web.app.transforms.RWIncrementalFetchTransform

All Implemented Interfaces:

AppTransform, Transform

public class RWIncrementalFetchTransform
extends AbstractRWTransform

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

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

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

AbstractRWTransform.ButtonAlignmentsHelper

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

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
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.AbstractRWTransform

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Return description for this Transform.
protected IncrementalFetch	getIncrementalFetchComponent()
protected boolean	shouldDisplay()	Determines whether the transform should render itself or not.
boolean	shouldDisplayIncrementalFetch()	Test for the conditions required for incremental fetch to be rendered
void	transformForRequestSuccessful(MarkupOutput mo)	Transform when the report status is "Successful".

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

displayError, generateErrorForIframe, getCancelEvent, getContinueEvent, getDocumentStatus, getDocumentStatusDescriptorKey, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, getRWBean, getRWFrame, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, initializeImages, initializeTransform, isDesignMode, renderHistoryListButton, renderImage, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderProcessingInfoStatus, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, updateVisTransform

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

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, getErrorMessage, getErrorTitle, 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, 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, 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, canTransform, 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

canTransform, 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

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

Constructor Detail

RWIncrementalFetchTransform

public RWIncrementalFetchTransform()

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

Method Detail

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 incremental fetch to be rendered

Returns:

true if incremental fetch is to be rendered.

shouldDisplay

protected boolean shouldDisplay()

Determines whether the transform should render itself or not.

Overrides:

shouldDisplay in class AbstractAppTransform

Returns:

boolean

getIncrementalFetchComponent

protected IncrementalFetch getIncrementalFetchComponent()

getDescription

public java.lang.String getDescription()

Return description for this Transform.

Returns:

description for this Transform