Package com.microstrategy.web.beans

Interface Transformable

All Known Subinterfaces:

AddressListBean, AdminBean, AdminTabBean, AlertsEditorBean, AllObjectBrowserBean, AnnotationBean, AppComponent, AppSchemaBean, AssociatedSchedulesBean, AttributeBean, AttributeFormsEditorBean, AttributeFormsQualificationBean, ChangePasswordBean, ColorGradientEditorBean, ColorPickerEditorBean, ConfirmOverwriteDialogBean, ConstantPromptBean, ContactsBrowserBean, ControlToolbarBean, CustomGroupBean, DataExplorerBean, DatasetObjectExplorerBean, DerivedElementBean, DerivedElementFormatEditorBean, DerivedElementsBrowserBean, DerivedElementsConvertDialogBean, DerivedElementsEditorBean, DiagnosticsBean, DimtyPromptBean, DirectExportBean, DocumentBean, DocumentFrameBean, DocumentFrameElement, DrillEditorBean, DrillFilterEditorBean, EditableObjectAppBean, EditableObjectBean, ElementPickerBean, ElementPromptBean, ExportBean, ExportOptionsEditorBean, ExpressionBean, ExpressionDisplayBean, ExpressionObject, ExpressionPromptBean, FilterAppBean, FilterBean, FilterDetailsFormattingEditorBean, FilterEditorBean, FilterElementBean, FilterFrameBean, FlashTabBean, FolderBean, FolderFrameBean, FolderObjectExplorerBean, FormatColorLinesTabBean, FormatNumberTabBean, FormatTabBean, FormatTabManagerBean, FormatToolbarBean, FormulaBarBean, FrameBean, FrameElement, FunctionEditorBean, GraphBean, GraphColorGradientEditorBean, GraphFormatEditorBean, GraphFormatToolbarBean, GraphTitleTabBean, GridAutoStylesBean, GridColorGradientEditorBean, GridFormatBean, GridFormatEditorBean, GridFormatToolbarBean, GroupbyPropertiesEditorBean, GroupPathBean, ImportDerivedElementsBean, ImportWizardBean, InboxBean, LimitExpressionBean, LoginBean, LogoutBean, MetricQualLevelEditorBean, ObjectBean, ObjectBrowserBean, ObjectBrowserManagerBean, ObjectBrowserTabBean, ObjectExplorerBean, ObjectManipulationDialogBean, ObjectPromptBean, ObjectSelectionBean, OMDCreateFolderBean, OptionsBean, PageByBean, PageComponent, PageSetupHTMLEditorBean, PathBean, PDFBean, PerformanceMonitorBean, PreferencesBean, PrintBean, ProjectBrowser, ProjectsBean, ProjectStatusBean, PromptAnswerBean, PromptAppBean, PromptBean, PromptConstantAppBean, PromptDefinitionAppBean, PromptDefinitionBean, PromptDetailsBean, PromptDimtyAppBean, PromptElementsAppBean, PromptExpressionAppBean, PromptHierarchyAppBean, PromptObject, PromptObjectAppBean, PromptsBean, PromptsContainerBean, PromptsContainerFrameBean, ReportBean, ReportDetailsBean, ReportFrameBean, ReportFrameElement, ReportObjectsTabBean, ReportWorkingSetBrowserTabBean, ResizeEditorBean, ResultSetBean, ResultSetFrameBean, RibbonBean, RWActionControlEditorBean, RWBean, RWDColorGradientEditorBean, RWFrameBean, RWGraphDropZonesEditorBean, RWProjectBrowserTabBean, RWViewBean, RWViewExpressionBean, RWWorkingSetBrowserTabBean, SaveAsBean, SaveObjectAsDialogBean, ScheduleBean, SearchBean, SecondaryDataSourcesEditorBean, SecurityFilterBean, SecurityFilterFrameBean, SecurityRoleBean, SecurityRoleUserEntitiesSelectorBean, SortEditorBean, SubscriptionBean, SubscriptionContactsBrowserBean, SubscriptionEditorBean, SubscriptionFolderBean, SubscriptionFrameBean, SubsetUnitLimitBean, SubsetUnitLimitElementBean, SubtotalsEditorBean, TabBean, TabManagerBean, TemplateElementsBean, TemplateFilterExecBean, ThresholdEditorBean, ThresholdExpressionBean, ToolbarBean, ToolbarSetBean, UserBean, UserContactsBrowserBean, UserEntitiesBean, UserEntitiesBrowserBean, UserEntitiesSelectorBean, UserEntityBean, UserGroupBean, UserSearchBean, ViewBean, ViewBeanParserBean, ViewFilterElementPanelBean, VisualizationPropertiesEditorBean, VisualizationsEditorBean, WebBean, WebHyperLinkEditorBean, WizardBean, WizardStepBean, XDADataExplorerBean

All Known Implementing Classes:

AbstractAppComponent, AbstractColorGradientEditorBeanImpl, AbstractFrameEditorBean, AbstractLimitExpressionBean, AbstractObjectBrowserTabBean, AbstractObjectExplorerBean, AbstractPersistableAppComponent, AbstractPersistableFrameElement, AbstractTemplateElementsBean, AbstractTransformable, AbstractViewBeanParserBean, AbstractWebComponent, AccordionTabManagerBeanImpl, AllObjectBrowserBeanImpl, AssociatedSchedulesBeanImpl, AttributeFormsQualificationBeanImpl, ColorGradientEditorBeanImpl, ControlToolbarBeanImpl, CreditsBean, CSRFConfirmationPageComponentImpl, DatasetObjectExplorerBeanImpl, DerivedElementBeanImpl, DerivedElementsBrowserBeanImpl, DesktopPageComponentImpl, DocumentPageComponentImpl, DrillEditorBeanImpl, EditPromptPageComponentImpl, ElementPickerBeanImpl, FilterDetailsFormattingEditorBeanImpl, FolderObjectExplorerBeanImpl, FolderPageComponentImpl, GraphColorGradientEditorBeanImpl, GraphTitleTabBeanImpl, GridColorGradientEditorBeanImpl, HistoryListPageComponentImpl, IOSSmartBannerBeanImpl, MySubscriptionsPageComponentImpl, NewWindowPageComponentImpl, OptimizedTabBeanImpl, OptionsBeanImpl, PageSetupHTMLEditorBeanImpl, PageSubscriptionsEdit, PathBeanImpl, PreferencesBeanImpl, PreferenceSettingPageComponentImpl, PreferencesPageComponentImpl, ProjectBrowserBeanImpl, PromptDetailsBeanImpl, ReportDetailsBeanImpl, ReportFrameBeanImpl, ReportPageComponentImpl, ResultSetPageComponentImpl, RibbonBeanImpl, RWDColorGradientEditorBeanImpl, RWGraphDropZonesEditorBeanImpl, RWOIVMPageComponent, RWPageComponentImpl, RWPromptsPageComponent, RWSaveAsPageComponentImpl, SearchPageComponentImpl, SecondaryDataSourcesEditorBeanImpl, SecurityRoleUserEntitiesSelectorBeanImpl, ServletWebComponent, SharingConfirmationPageComponentImpl, SimplePageComponentImpl, ThresholdExpressionBeanImpl, ViewFilterElementPanelBeanImpl, VisualizationPropertiesEditorBeanImpl, VisualizationsEditorBeanImpl, XDADataExplorerBeanImpl

public interface Transformable

This interface represents objects that support Transform functionality.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
TransformInstance	addTransform(Transform transform)	Adds a Transform object into the collection of transforms.
TransformInstance	addTransformByClass(java.lang.String transformClass)	Adds into the collection of transforms a Transform object with the specified fully qualified class name.
TransformInstance	addTransformByStyle(java.lang.String styleName)	Adds into the collection of transforms a Transform object with the specified style name.
TransformInstance	addTransformByStyle(java.lang.String styleName, StyleRequestContext context)	Adds into the collection of transforms a Transform object with the specified style name.
void	clearTransforms()	Deletes all transforms added to the object
BeanContext	getBeanContext()	Returns the BeanContext instance.
java.lang.String	getMessageString(java.lang.String key)	Returns the string descriptor from a Messages instance, which is in turn retrieved from the BeanContext if any.
java.util.Enumeration	getMyTransformInstances()
TransformInstance	getTransformInstance()	Returns the default TransformInstance object
TransformInstance	getTransformInstance(java.lang.String key)	Returns the TransformInstance object with the specified key.
java.util.Enumeration	getTransformInstances()	Retuns a java.util.Enumeration over all the TransformInstance objects.
int	getType()	Returns the transformable type as in EnumWebTransformableType.
boolean	hasTransform()	Returns a boolean value indicating whether there is a default TransformInstance object.
boolean	hasTransform(java.lang.String key)	Returns a boolean value indicating whether there is such a TransformInstance object with the specified key.
void	invalidateTransformCache()	This method is called by any transformable object after collecting data
void	setBeanContext(BeanContext beanContext)	Sets an instance of BeanContext on the current Transformable object.
MarkupOutput	transform()	Performs transform on a component by the default TransformInstance object.
MarkupOutput	transform(java.lang.String key)	Performs transform on a component by the TransformInstance with the specified key.

Method Detail

getType

int getType()

Returns the transformable type as in EnumWebTransformableType.

Returns:

the transformable type.

addTransform

TransformInstance addTransform(Transform transform)

Adds a Transform object into the collection of transforms. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

The collection of TransformInstance is a synchronized collection.

Parameters:

transform - a Transform to add

Returns:

a TransformInstance holding the transform added.

addTransformByClass

TransformInstance addTransformByClass(java.lang.String transformClass)
                               throws WebTransformException

Adds into the collection of transforms a Transform object with the specified fully qualified class name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

The collection of TransformInstance is a synchronized collection.

Parameters:

transformClass - the fully qualified class name of the Transform object to be added.

Returns:

a TransformInstance holding the transform added.

Throws:

WebTransformException - thrown if the specified transform can not be found or instantiated.

addTransformByStyle

TransformInstance addTransformByStyle(java.lang.String styleName)
                               throws WebTransformException

Adds into the collection of transforms a Transform object with the specified style name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

The collection of TransformInstance is a synchronized collection.

Parameters:

styleName - the style name in a style catalog.

Returns:

a TransformInstance holding the transform added.

Throws:

WebTransformException - thrown if the specified transform can not be instantiated.

hasTransform

boolean hasTransform()

Returns a boolean value indicating whether there is a default TransformInstance object.

Returns:

true if there is a default transform.

hasTransform

boolean hasTransform(java.lang.String key)

Returns a boolean value indicating whether there is such a TransformInstance object with the specified key.

Parameters:

key - the key of a Transform

Returns:

true if there is such a TransformInstance with the specified key.

getTransformInstance

TransformInstance getTransformInstance()

Returns the default TransformInstance object

Returns:

the default TransformInstance object; null if there is no default TransformInstance object.

getTransformInstance

TransformInstance getTransformInstance(java.lang.String key)
                                throws KeyDoesNotExistException

Returns the TransformInstance object with the specified key.

Parameters:

key - the key of a TransformInstance.

Returns:

the TransformInstance object with the specified key.

Throws:

KeyDoesNotExistException - thrown if the key is not found.

transform

MarkupOutput transform()
                throws TransformDoesNotExistException

Performs transform on a component by the default TransformInstance object. This method is synchronized on the TransformInstance object.

Returns:

a MarkupOutput object containing the result of transform.

Throws:

TransformDoesNotExistException - thrown if there is no default TransformInstance or the transform can not be performed.

transform

MarkupOutput transform(java.lang.String key)
                throws KeyDoesNotExistException,
                       TransformDoesNotExistException

Performs transform on a component by the TransformInstance with the specified key. This method is synchronized on the TransformInstance object.

Parameters:

key - the key of a TransformInstance object.

Returns:

a MarkupOutput object containing the result of transform.

Throws:

TransformDoesNotExistException - thrown if there is no such a TransformInstance or the transform can not be performed.

KeyDoesNotExistException - thrown if the key is not found.

getTransformInstances

java.util.Enumeration getTransformInstances()

Retuns a java.util.Enumeration over all the TransformInstance objects.

Returns:

a java.util.Enumeration over all the TransformInstance objects.

getBeanContext

BeanContext getBeanContext()

Returns the BeanContext instance.

Returns:

the BeanContext instance.

setBeanContext

void setBeanContext(BeanContext beanContext)

Sets an instance of BeanContext on the current Transformable object.

Parameters:

beanContext - a BeanContext object.

getMessageString

java.lang.String getMessageString(java.lang.String key)

Returns the string descriptor from a Messages instance, which is in turn retrieved from the BeanContext if any. The string descriptor is mapped by the specified key. A String of value "ERROR" is returned if there is no such a string descriptor.

Parameters:

key - the key mapped to a string descriptor in a Messages

Returns:

the string descriptor from a Messages.

invalidateTransformCache

void invalidateTransformCache()

This method is called by any transformable object after collecting data

Since:

MicroStrategy Web 8.0.0

clearTransforms

void clearTransforms()

Deletes all transforms added to the object

Since:

MicroStrategy Web 8.0.0

addTransformByStyle

TransformInstance addTransformByStyle(java.lang.String styleName,
                                      StyleRequestContext context)
                               throws WebTransformException

Adds into the collection of transforms a Transform object with the specified style name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

The collection of TransformInstance is a synchronized collection.

Parameters:

styleName - the style name in a style catalog.

context - the StyleRequestContext object.

Returns:

a TransformInstance holding the transform added.

Throws:

WebTransformException - thrown if the specified transform can not be instantiated.

Since:

MicroStrategy Web 8.0.1

getMyTransformInstances

java.util.Enumeration getMyTransformInstances()

Since:

MicroStrategy Web 9.0.0