All Known Subinterfaces:

AppTransform, LayoutTransform, ReportDataTransform

All Known Implementing Classes:

AbstractAdminPathTransform, AbstractAdminTransform, AbstractAppTransform, AbstractAppWidgetTransform, AbstractBasicMojoVisualizationDataTransform, AbstractBasicReportTransform, AbstractChangePasswordTransform, AbstractColorGradientEditorTransform, AbstractDiagnosticsTransform, AbstractDocumentTransform, AbstractEditorTransform, AbstractExportTransform, AbstractExpressionTransform, AbstractFilterElementTransform, AbstractFolderTransform, AbstractFormatTabTransform, AbstractHeaderFooterTransform, AbstractLayoutTransform, AbstractMobileSubscriptionTask.SimpleSubscriptionTransform, AbstractMojoRWTransform, AbstractMojoTransform, AbstractObjectBrowserTabTransform, AbstractObjectExplorerTransform, AbstractObjectExplorerTreeTransform, AbstractObjectInfoListTransform, AbstractOptionsTransform, AbstractPreferencesTransform, AbstractPrivilegesEditorTransform, AbstractPromptEditorTransform, AbstractPromptExpressionTransform, AbstractPromptObjectTransform, AbstractPromptWidgetTransform, AbstractReportDataTransform, AbstractReportDataVisualizationTransform, AbstractReportExportTransform, AbstractReportGridExportTransform, AbstractReportGridTransform, AbstractReportOutlineModeExportTransform, AbstractReportTransform, AbstractReportXMLTransform, AbstractRWDataVisualizationTransform, AbstractRWTransform, AbstractScheduleListTransform, AbstractServerPropertiesTransform, AbstractSimplifiedRWXMLTransform, AbstractSubscriptionEditTransform, AbstractSubscriptionFolderBeanTransform, AbstractSubscriptionListTransform, AbstractSubscriptionsEditorTransform, AbstractTabTransform, AbstractTransform, AbstractUserEntitiesTreeCartTransform, AbstractWebBeanTransform, AccordionTabBeanTransform, AccordionTabManagerTransform, AddDataSetWizardTransform, AddressDeleteTransform, AddressListFileTransform, AddressListPrintTransform, AddressListTransform, AddressTransform, AdminFolderQuickSearchResultsTransform, AdminFolderSearchResultsTransform, AdminFolderViewTransform, AdminGenericTabTransform, AdminPathTransform, AdvancedThresholdsEditorTransform, AdvSortDataTransform, AlertsEditorTransform, AlertsObjectExplorerTransform, AllObjectBrowserHTMLTransform, AllObjectBrowserTransform, AndroidMapTransformImpl, AndroidMessageResultTransform, AnnotationsTransform, AttributeElementsWidgetTransform, AttributeFormsEditorTransform, AttributeFormsQualificationTransform, BeanGeneratedOutputTransform, BlockColorPickerTransform, ChangePasswordGeneralTransform, ChangePasswordPreferencesTransform, ColorGradientEditorTransform, ColorPickerEditorTransform, ConfirmOverwriteDialogTransform, ConnectedServersTransform, ConstantPromptEditorTransform, ControlToolbarTransform, CubeExplorerForViewReportTransform, CurrentItemTransform, DataExplorerElementsWidgetTransform, DataExplorerFolderWidgetTransform, DataExplorerTransform, DataExplorerWidgetTransform, DataImportTransform, DatasetObjectExplorerTransform, DerivedElementCalculationTransform, DerivedElementFilterTransform, DerivedElementFormatEditorTransform, DerivedElementListTransform, DerivedElementsBrowserTransform, DerivedElementsConvertDialogTransform, DerivedElementsEditorTransform, DerivedElementTransform, DesktopPathTransform, DiagnosticsPropertiesTransform, DiagnosticsStatisticsTransform, DiagnosticsViewerTransform, DialogPathTransform, DirectExportTransform, DocumentDetailsTransform, DocumentDetailsXHTMLTransform, DocumentExportTransform, DocumentFastExportTransform, DocumentGridToolbarBlockLoaderTransform, DocumentInsertToolbarBlockLoaderTransform, DocumentSimpleTransform, DocumentToolbarTransform, DrillFilterEditorTransform, EditorToolbarTransform, ElementPickerTransform, ElementsPromptEditorTransform, EmptyTransform, ESRIMapTransform, ESRIVisualizationPropertiesTransform, ExportOptionsEditorTransform, ExportTransform, ExpressionFilterTransform, ExpressionGenericTransform, ExpressionPlainTextTransform, ExpressionPromptEditorTransform, FilterAllObjectBrowserTransform, FilterDetailsEditorTransform, FilterDetailsFormattingEditorTransform, FilterElementRWTransform, FilterElementTransform, FilterExpressionTransform, FilterObjectBrowserTransform, FilterTransform, FloatingEditorBlockTransform, FolderAddDataSetExplorerTransform, FolderAddDataSetTransform, FolderAdminBrowserTransform, FolderBulletReportsTransform, FolderBulletRWTransform, FolderBulletTransform, FolderCreateDocumentTransform, FolderCreateReportTransform, FolderCreateReportXHTMLTransform, FolderDeleteObjectTransform, FolderDetailsTransform, FolderFrameTreeTransform, FolderIconRadioButtonTransform, FolderIconTransform, FolderListTransform, FolderObjectBrowserTransform, FolderObjectExplorerTransform, FolderOMDBrowserTransform, FolderProjectBrowserTransform, FolderQuickSearchResultsXHTMLTransform, FolderQuickSearchTransform, FolderRadioButtonTransform, FolderSaveAsBrowserTransform, FolderSaveAsTransform, FolderSaveAsXHTMLTransform, FolderSearchResultsTransform, FolderSearchResultsXHTMLTransform, FolderSmallIconTransform, FolderSummaryCreateDocumentTransform, FolderSummaryCreateReportTransform, FolderSummaryTransform, FolderSummaryViewTransform, FolderTreeTransform, FolderViewTransform, FolderViewWidgetTransform, FolderViewXMLTransform, FormatEditorTabManagerTransform, FormatPromptNumberTransform, FormatTabAlignmentTransform, FormatTabColorLinesTransform, FormatTabEffectsTransform, FormatTabFontTransform, FormatTabNumberTransform, FormatToolbarTransform, FormulaBarTransform, FrameGenericTransform, FunctionEditorTransform, GenericEditorTransform, GoogleMapTransform, GoogleMapVisualizationDataTransformImpl, GraphImageTransform, GridAutoStylesTransform, GroupbyPropertiesEditorTransform, GroupPathTransform, GuiElementsBlockTransform, HelpOnCBTabManagerTransform, HelpSetupTransform, HyperLinkObjectExplorerTransform, ImageLayoutVisualizationPropertiesTransform, ImageMapVisualizationDataTransform, ImageViewerVisualizationPropertiesTransform, ImportDerivedElementsTransform, ImportWizardFlashTransform, InboxClearTransform, InboxDetailsTransform, InboxExtrasTransform, InboxListTransform, InboxListXHTMLTransform, InboxToolbarTransform, InsertLayoutBlockTransform, InsertMenuBlockTransform, InteractiveGridVisualizationDataTransform, IPadTimeLineVisualizationPropertiesTransform, IPhoneGridVisualizationPropertiesTransform, IPhoneImageMapPropertiesTransform, IPhoneMapVisualizationPropertiesTransform, IPhoneMarkerMashupVisualizationPropertiesTransform, IPhoneReportDataXMLTransform, IPhoneReportGridTransformImpl, IPhoneReportInteractiveGridXMLTransform, IPhoneReportMapXMLTransform, IPhoneReportXMLTransform, IPhoneRWTransform, IPhoneTimeSeriesEditorTransform, JsonRWDTransform, LimitElementTransform, LoginContinueTransform, LoginTransform, LoginXHTMLTransform, LogoutTransform, MDXReportLimitElementTransform, MenuBlockTransform, MetricQualLevelEditorTransform, MobileChunkedGraphDataTransform, MobileChunkedRWTransform, MobileDataXMLTransform, MobileGraphXMLTransform, MobileHTMLGridTransform, MobilePreambleXMLTransform, MojoAttributeTransform, MojoCustomGroupTransform, MojoFolderTransform, MojoIVETransform, MojoMapTransform, MojoPathTransform, MojoRWDTransform, MojoServerJsonVisualizationDataTransform, MojoSubscriptionTransform, MojoTemplateTransformImpl, MojoToolbarTransform, MojoVisualizationDataTransform, MojoVisualizationDateSelectionTransform, MojoVisualizationSimplifiedDataTransform, MojoXtabTransformImpl, MultiMediaVisualizationPropertiesTransform, MultipleObjectSelectorTransform, ObjectBrowserManagerTransform, ObjectBrowserTabOMDTransform, ObjectBrowserTabProjectBrowserTransform, ObjectBrowserTabReportAllObjectsTransform, ObjectBrowserTabReportWorkingSetTransform, ObjectBrowserTabRWWorkingSetTransform, ObjectExplorerBlockTransform, ObjectInfoTransform, ObjectManipulationDialogTransform, ObjectPathTransform, ObjectPathXHTMLTransform, ObjectReportPathTransform, ObjectReportXHTMLPathTransform, ObjectSelectorProjectBrowserTransform, ObjectSelectorTransform, ObjectSiblingsTransform, ObjectsPromptEditorTransform, OfficeTransform, OIVMToolbarTransform, OMDCreateFolderTransform, OndemandContextMenusTransform, OndemandDrillContextMenusTransform, OtherConfigurationTransform, PageByTransform, PageSetupHTMLEditorTransform, PathTransform, PDFTransform, PreferencesDocumentTransform, PreferencesDrillTransform, PreferencesExcelHeaderFooterTransform, PreferencesExportAdminHeaderFooterTransform, PreferencesExportTransform, PreferencesFolderTransform, PreferencesGeneralTransform, PreferencesGenericTransform, PreferencesGraphTransform, PreferencesGridProjectLevelTransform, PreferencesGridTransform, PreferencesInboxTransform, PreferencesLogoutTransform, PreferencesNCTransform, PreferencesOfficeTransform, PreferencesPDFReportHeaderFooterTransform, PreferencesPDFTransform, PreferencesPrintHeaderFooterTransform, PreferencesPrintTransform, PreferencesProjectTransform, PreferencesPromptsLayoutTransform, PreferencesPromptsTransform, PreferencesScheduleTransform, PreferencesSecurityTransform, PreferencesToolbarTransform, PreferencesUserGroupsTransform, PrettyPrintTransform, PrintTransform, ProjectBrowserTransform, ProjectStatusTransform, ProjectsTransform, PromptAnswerTransform, PromptCartTransform, PromptCartXHTMLTransform, PromptCheckboxTransform, PromptConstantTransform, PromptConstantWidgetTransform, PromptDetailsTransform, PromptDimtyWidgetTransform, PromptEditorJavaScriptBoneTransform, PromptEditorTabManagerTransform, PromptEditorTabTransform, PromptElementsWidgetTransform, PromptExpressionCartTransform, PromptExpressionCartWithPickerTransform, PromptExpressionCartXHTMLTransform, PromptExpressionListTransform, PromptExpressionNonCartTransform, PromptExpressionTextboxTransform, PromptExpressionTransform, PromptExpressionWidgetTransform, PromptHierarchicalCartTransform, PromptHierarchicalCartXHTMLTransform, PromptHierarchicalTreeTransform, PromptHierarchicalTreeXHTMLTransform, PromptHierarchyWidgetTransform, PromptListboxTransform, PromptObjectBrowsingTransform, PromptObjectBrowsingXHTMLTransform, PromptObjectWidgetTransform, PromptPathTransform, PromptRadioTransform, PromptsClassicTransform, PromptsContainerTransform, PromptsCreateReportContainerTransform, PromptsCreateReportTransform, PromptsIFrameTransform, PromptsSubscriptionTransform, PromptsSummaryTransform, PromptXSLTransform, ReportAjaxMojoVisualizationTransform, ReportAjaxVisualizationTransform, ReportDesignModeTransformImpl, ReportDetailsPanelTransform, ReportDetailsTransform, ReportDetailsXHTMLTransform, ReportErrorVisualizationTransform, ReportExportExcelFormattingTransform, ReportExportExcelFormatTransform, ReportExportHTMLFormatTransform, ReportExportHTMLTransform, ReportExportIServerTransform, ReportExportPlainTextTransform, ReportFlashTransform, ReportFrameClassicTransform, ReportFrameGenericTransform, ReportGoogleGraphVisualizationTransform, ReportGraphDesignTransform, ReportGraphImageTransform, ReportGraphTransformImpl, ReportGridExcelTransform, ReportGridGraphTransformImpl, ReportGridHTMLTransform, ReportGridPrintTransform, ReportGridToolbarBlockLoaderTransform, ReportGridTransformImpl, ReportHomeExportMenuBlockTransform, ReportIncrementalFetchTransform, ReportLastUpdateTransform, ReportOptionsTransform, ReportOutlineModeExcelTransform, ReportOutlineModeHTMLTransform, ReportOutlineModeTransformImpl, ReportPageByInfoTransform, ReportPageByTransform, ReportPathTransform, ReportQuickLinksTransform, ReportSavePropertiesTransform, ReportTimelineVisualizationTransform, ReportTimelineXMLTransform, ReportToolbarTransform, ReportWorkingSetObjectsTransform, ReportXMLTransform, ResizeEditorTransform, RestrictedFolderObjectExplorerTransform, ResultSetFrameTransform, ResultSetStatusTransform, RibbonToolbarTransform, RWActionControlEditorTransform, RWDColorGradientEditorTransform, RWDetailsTransform, RWDocPropertiesEditorTransform, RWExportTransform, RWFlashDashboardTransform, RWFlashTransform, RWFrameGenericTransform, RWGraphDropZonesEditorTransform, RWGridTransform, RWIncrementalFetchTransform, RWLastUpdateTransform, RWLayoutTabStripTransform, RWLayoutTransform, RWOutlineViewTransform, RWPathTransform, RWPDFTransform, RWPromptsPathTransform, RWPropertiesEditorTransform, RWReportGraphDesignDropZoneTransformImpl, RWReportGraphDropZoneTransformImpl, RWSavePropertiesTransform, RWXMLTransform, SampleTransform, SaveAsReportTransform, SaveAsRWTransform, SaveAsTransform, SaveObjectAsDialogTransform, ScheduleEditTransform, ScheduleOverwriteTransform, SchedulesBulletTransform, SchedulesFilteredListTransform, SchedulesFilteredListXHTMLTransform, SchedulesIconTransform, SchedulesIconXHTMLTransform, SchedulesListTransform, SchedulesListXHTMLTransform, SearchSimpleTransform, SearchSuggestTransform, SecondaryDataSourcesEditorTransform, SecurityFilterExpressionTransform, SecurityFilterFrameTransform, SecurityFilterTransform, SecurityRoleEditorTransform, SecurityRolePathTransform, SecurityRoleUserEntitiesSelectorTransform, SecurityTransform, ServerPropertiesTransform, ShareURLTransform, SimpleThresholdsEditorTransform, SingleObjectSelectorTransform, SortEditorTransform, SortGeneralTransform, SortTabBeanTransform, SubscriptionConfirmSendNowTransform, SubscriptionConfirmTransform, SubscriptionContactsBrowserTransform, SubscriptionEditCacheTransform, SubscriptionEditFileTransform, SubscriptionEditFTPTransform, SubscriptionEditInboxTransform, SubscriptionEditMobileTransform, SubscriptionEditPrintTransform, SubscriptionEditTransform, SubscriptionFrameTransform, SubscriptionPersonalViewTransform, SubscriptionsBulletTransform, SubscriptionsEditorHistoryListTransform, SubscriptionsEditorMobileTransform, SubscriptionsEditorNCCacheTransform, SubscriptionsEditorNCFileTransform, SubscriptionsEditorNCFTPTransform, SubscriptionsEditorNCPrintTransform, SubscriptionsEditorNCSendNowTransform, SubscriptionsEditorNCTransform, SubscriptionsEditorPersonalViewTransform, SubscriptionsEditorTransform, SubscriptionSendNowTransform, SubscriptionsFilteredListTransform, SubscriptionsFilteredListXHTMLTransform, SubscriptionsIconTransform, SubscriptionsIconXHTMLTransform, SubscriptionsListTransform, SubscriptionsListXHTMLTransform, SubscriptionsPageByAttributesTransform, SubsetViewLimitElementDialogTransform, SubsetViewLimitElementTransform, SubtotalsDHTMLTransform, SubtotalsEditorTabManagerTransform, SubtotalsEditorTransform, SurveyVisualizationPropertiesTransform, TabBeanTransform, TabDocumentAdvancedTransform, TabDocumentExportTransform, TabDocumentOtherTransform, TabDocumentTableOfContentsTransform, TabDocumentWatermarkTransform, TabGraphAdvancedTransform, TabGraphAxesTransform, TabGraphGeneralTransform, TabGraphNumberTransform, TabGraphOptionsTransform, TabGraphTitlesTransform, TabLayoutTransform, TabManagerTransform, TabPageMarginTransform, TabPageOutputTransform, TabPageSetupTransform, TabPropertiesAdvancedTransform, TabPropertiesDeliveryTransform, TabPropertiesFlashTransform, TabPropertiesGeneralTransform, TabPropertiesGridTransform, TabPropertiesLayoutTransform, TabPropertiesLineTransform, TabPropertiesOtherGridTransform, TabPropertiesPictureTransform, TabPropertiesSelectorTransform, TabSectionsTransform, TemplateFilterExecTransform, TemplateFilterExecXHTMLTransform, ThresholdExpressionTransform, ThresholdsEditorTransform, ThresholdsFormatEditorTransform, TimelineMojoVisualizationDataTransform, TimeSeriesVisualizationDataTransform, ToolbarSetTransform, ToolbarTransform, TreePickerVisualizationPropertiesTransform, TreeTabManagerTransform, TrustRelationshipTransform, UnconnectedServersTransform, UserAddressListTransform, UserAnalysisQuotaEditorTransform, UserContactsBrowserCartTransform, UserEntitiesSelectorTreeCartTransform, UserEntitiesTransform, UserEntityEditorTransform, UserEntityPrivilegesTransform, UserGroupTransform, UsherConfigTransform, ViewFilterEditorRWTransform, ViewFilterElementPanelTransform, ViewFilterElementRWTransform, ViewFilterElementTransform, VIMojoAttributeFormTransform, VisualizationPropertiesEditorTransform, VisualizationPropertiesTransform, VisualizationsEditorTransform, WebHyperLinkEditorTransform, WizardStepTransform, WizardTransform, XDADataExplorerTransform
```
public interface Transform
```
The Transform interface is the base interface that is used for all bean-specific transforms.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`canTransform(Transformable data)`	Checks that the transform supports specified data object and that object is in the state supported by this transform.
`java.lang.String`	`getDescription()`	Returns a textual description of the transform.
`FormalParameters`	`getFormalParams()`	Returns the collection of formal parameters associated with this transform.
`java.lang.String`	`getID()`	Returns the unique name of the component to be used as the ID for its shell
`MarkupOutput`	`getPreview()`	Deprecated. This feature is not used
`java.lang.Class`	`getSupportedBeanType()`	Returns a root class/interface supported by this transform.
`boolean`	`isPreviewAvailable()`	Deprecated. This feature is not used
`boolean`	`isResolved()`	Returns whether each required formal parameter has a value associated with it.
`boolean`	`supports(Transformable data)`	Returns true if the transform supports the specified data object.
`boolean`	`supports(java.lang.Class beanClass)`	Returns true if the transform supports objects of specified type.
`void`	`transform(Transformable data, MarkupOutput transOut)`	Transforms the data object and appends result to the transOut.

- Method Detail
  - getDescription
```
java.lang.String getDescription()
```
    Returns a textual description of the transform.
    
    Returns:
    
    The textual description of the transform.
  - getFormalParams
```
FormalParameters getFormalParams()
```
    Returns the collection of formal parameters associated with this transform.
    
    Returns:
    
    FormalParameters interface, which is a collection of formal parameters.
  - isResolved
```
boolean isResolved()
```
    Returns whether each required formal parameter has a value associated with it.
    
    Returns:
    
    whether each required formal parameter has a value.
  - isPreviewAvailable
```
boolean isPreviewAvailable()
```
    Deprecated.
    This feature is not used
    
    Returns true if this transform supports preview functionality, false otherwise.
    
    Returns:
    
    true if this transform supports preview functionality, false otherwise.
  - getPreview
```
MarkupOutput getPreview()
                 throws java.lang.UnsupportedOperationException
```
    Deprecated.
    This feature is not used
    
    Produces a preview output for this transform.
    
    Returns:
    
    a MarkupOutput containing preview of this transform.
    
    Throws:
    
    java.lang.UnsupportedOperationException - in case the transform does not support preview functionality
  - transform
```
void transform(Transformable data,
               MarkupOutput transOut)
        throws java.lang.ClassCastException
```
    Transforms the data object and appends result to the transOut.
    
    Parameters:
    
    data - an object to transform. It must be of proper type supported by the concrete transform this method called on, or ClassCastExcetption will be thrown
    
    transOut - the MarkupOutput object where the transform result will be added.
    
    Throws:
    
    java.lang.ClassCastException - if data is of the wrong type.
  - getSupportedBeanType
```
java.lang.Class getSupportedBeanType()
```
    Returns a root class/interface supported by this transform. We assume here that each transform supports only beans belonging to one class hierarchy.
    
    Returns:
    
    a root class/interface supported by this transform.
  - supports
```
boolean supports(Transformable data)
```
    Returns true if the transform supports the specified data object. The check is performed only on the object's type, no object state is taken into account.
    
    Parameters:
    
    data - a transformable object
    
    Returns:
    
    true if the transform supports the data object, false otherwise.
    
    See Also:
    
    canTransform(com.microstrategy.web.beans.Transformable)
  - supports
```
boolean supports(java.lang.Class beanClass)
```
    Returns true if the transform supports objects of specified type.
    
    Parameters:
    
    beanClass - the Java Class object representing bean type.
    
    Returns:
    
    true if the transform supports objects of specified type.
  - canTransform
```
boolean canTransform(Transformable data)
```
    Checks that the transform supports specified data object and that object is in the state supported by this transform.
    
    Returns:
    
    true if the transform supports specified data object and the object is in the state supported by this transform.
  - getID
```
java.lang.String getID()
```
    Returns the unique name of the component to be used as the ID for its shell
    
    Returns:
    
    the component's unique id
    
    Since:
    
    MicroStrategy Web 8.0.0

Interface Transform

Method Summary

Method Detail

getDescription

getFormalParams

isResolved

isPreviewAvailable

getPreview

transform

getSupportedBeanType

supports

supports

canTransform

getID