ThresholdExpressionBean

Class Overview

The ThresholdExpressionBean represents an ExpressionBean that is editing a threshold's conditional expression. The primary difference between this and a standard ExpressionBean is that this bean exposes a reset method, allowing the user to signal to the bean that it should throw away its state, because the user has chosen a different subexpression to edit.

Summary

[Expand] Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState int MAXIMAL_STATE_INFO Specifies maximal state information to save This type of state (of a component) usually represents the complete definition of the component (including all the changes that may have been made to it) int MINIMAL_STATE_INFO Specifies that only the minimal state information to save int TYPICAL_STATE_INFO Specifies typical state information to save This type of state (of a component) usually represents information about its initialization and all the changes that have been made to the component.

[Expand] Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable abstract boolean restoreState(String state) Restores a component based on its saved state. abstract boolean restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing. abstract String saveState() Returns a java.lang.String representaion of a component. abstract String saveState(int howMuchState) Returns a java.lang.String representaion of a component. abstract void saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a StringBuffer. abstract void saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a StringBuffer.
From interface com.microstrategy.web.beans.ExpressionBean abstract void acceptChange() Accepts the change that is currently being worked upon. abstract boolean canSelectElements(WebAttribute webAttribute) Returns true if Select Elements option can be used for the attribute abstract WebAttributeForm chooseDefaultForm(WebAttribute attr) abstract WebObjectInfo getActiveObject() Returns the active object, the object being qualified upon. abstract int getActiveOperatorNodeKey() Returns the current active operator node key. abstract WebElementSource getElementSource(WebAttribute att) Returns properly initialized element source for a given attribute. abstract WebExpression getExpression() Returns the internal expression object. abstract int getExpressionBeanType() Returns the expression bean type, from EnumExpressionBeanType. abstract int getExpressionEditMode() Returns the current expression edit mode of the bean, from EnumExpressionEditMode. abstract Scrollable getIncrementalFetch() Returns a Scrollable interface, which can be used to set the incremental fetch window for an attribute elements qualification. abstract boolean getMatchCase() Returns the match case flag, used in searching element browsing request. abstract WebObjectInfo getRHS() Returns the unit(attribute form/metric) used on the Right Hand Side(RHS) of the filter comparison abstract String getUserSearchPattern() Returns the search pattern that will be applied to any element browsing request. abstract WebBeanError getValidationErrorInfo() This can hold a validation error which came about from the validate call. abstract boolean isEditable() Returns whether the Expression bean is editable. abstract boolean isEditable(WebNode node) Returns whether the given node can be edited properly under the current context of the application. abstract boolean isModified() Returns whether this filter is modified from the filter object that it synchronizes with. abstract void populateObject(WebObjectInfo oi) abstract void resetChanges() Undoes all changes since the last synchronize call. abstract void setActiveOperatorNodeKey(int key, boolean isNew) Sets the current active operator node key. abstract void setContext(ExpressionBeanContext context) Sets the ExpressionBeanContext. abstract void setExpressionEditMode(int mode) Sets the current expression edit mode of the bean, from EnumExpressionEditMode. abstract void setIsEditable(boolean value) Sets whether the expression bean is editable. abstract void setMatchCase(boolean matchCase) Sets the match case flag, which determines whether the user search pattern must match case or not. abstract void setRHS(WebObjectInfo rhs) Set the unit(attribute form/metric) used on the Right Hand Side(RHS) of the filter comparison abstract void setUserSearchPattern(String pattern) Sets the search pattern that will be applied to any element browsing request. abstract void setValidationErrorInfo(WebBeanError err) abstract boolean shallSelectElements(WebAttribute webAttribute) This method is used to decide what Attribute subexpression to create in a given context. abstract void synchronize() Synchronizes any changes that have been made to this expression to the owner expression accessible on the WebReportInstance or WebPrompt object. abstract void undoChange() Undoes the change that is currently being worked upon. abstract boolean validate() Attempts to perform validation on the expression. abstract boolean validateOperands(WebNode node) Returns whether the given node and its children are valid.
From interface com.microstrategy.web.beans.RequestPersistable abstract boolean restoreStateFromRequest(RequestKeys rk, String keyName) Restores a WebComponent based on the RequestKeys instance. abstract boolean restoreStateFromRequest(RequestKeys rk) Restores a WebComponent based on the RequestKeys instance.
From interface com.microstrategy.web.beans.Transformable abstract TransformInstance addTransform(Transform transform) Adds a Transform object into the collection of transforms. abstract TransformInstance addTransformByClass(String transformClass) Adds into the collection of transforms a Transform object with the specified fully qualified class name. abstract TransformInstance addTransformByStyle(String styleName) Adds into the collection of transforms a Transform object with the specified style name. abstract TransformInstance addTransformByStyle(String styleName, StyleRequestContext context) Adds into the collection of transforms a Transform object with the specified style name. abstract void clearTransforms() Deletes all transforms added to the object abstract BeanContext getBeanContext() Returns the BeanContext instance. abstract String getMessageString(String key) Returns the string descriptor from a Messages instance, which is in turn retrieved from the BeanContext if any. abstract Enumeration getMyTransformInstances() abstract TransformInstance getTransformInstance() Returns the default TransformInstance object abstract TransformInstance getTransformInstance(String key) Returns the TransformInstance object with the specified key. abstract Enumeration getTransformInstances() Retuns a java.util.Enumeration over all the TransformInstance objects. abstract int getType() Returns the transformable type as in EnumWebTransformableType. abstract boolean hasTransform() Returns a boolean value indicating whether there is a default TransformInstance object. abstract boolean hasTransform(String key) Returns a boolean value indicating whether there is such a TransformInstance object with the specified key. abstract void invalidateTransformCache() This method is called by any transformable object after collecting data abstract void setBeanContext(BeanContext beanContext) Sets an instance of BeanContext on the current Transformable object. abstract MarkupOutput transform(String key) Performs transform on a component by the TransformInstance with the specified key. abstract MarkupOutput transform() Performs transform on a component by the default TransformInstance object.
From interface com.microstrategy.web.beans.WebBean abstract Document getDocument() Returns a org.w3c.dom.Document parsed from the XML representation of this bean. abstract WebBeanError getErrorInfo() Returns a WebBeanError object indicating processing error during the collectData method call. abstract WebSessionInfo getSessionInfo() Returns the WebSessionInfo instance from this bean. abstract boolean isStale() Returns a boolean value indicating whether the content of this bean is stale. abstract void setSessionInfo(WebSessionInfo sessionInfo) Sets a new WebSessionInfo instance on this bean. abstract void setStale(boolean stale) Sets a flag indicating whether this bean is stale or fresh.
From interface com.microstrategy.web.beans.WebComponent abstract void addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent. abstract void addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing ParameterBuilder instance. abstract void addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing ParameterBuilder instance. abstract void collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous. abstract void collectMinimalData() This is similar to collectData() except data collected is minimal. abstract MarkupOutput generateOutput() This is the generic method to ask the WebComponent to generate some output for the client. abstract BeanContext getBeanContext() Returns an instance of BeanContext. abstract WebComponent getChild(int index) Returns the child WebComponent instance specified by the index. abstract WebComponent getChild(String key) Returns the child WebComponent instance specified by the key. abstract WebComponent getChildByClass(Class className) Returns the child WebComponent instance specified by the class. abstract WebComponent getChildByType(int childType) Returns the child WebComponent instance specified by the component type(EnumWebTransformableType). abstract int getChildCount() Returns the total number of children on the current WebComponent. abstract void getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name abstract int getDefaultStateLevel() Returns the default state level for the WebComponent. abstract WebFeatures getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent abstract int getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent. abstract String getName() Returns the name of the current WebComponent. abstract int getOutputFormat() Returns the output format of EnumBeanOutputFormat of the current WebComponent. abstract WebComponent getParent() Returns the parent WebComponent of the current WebComponent. abstract String getPath() Returns the path from the root WebComponent to the current WebComponent. abstract int getPersistMode() Returns the persist flag (EnumBeanPersistMode) of the current WebComponent. abstract Set getRenderingFilter() returns the rendering filter. abstract WebComponent getRoot() Returns the root of the current WebComponent. abstract WebComponent getTargetBean() Get the target bean associated with this instance abstract String getTargetBeanPath() abstract WebEvent getWebEvent(int event, boolean recurse) Returns the WebEvent instance with the specified event ID. abstract WebEvent getWebEvent(int event) Returns the WebEvent instance with the specified event ID. abstract WebEventHandler getWebEventHandler() Returns the WebEventHandler instance associated with the current WebComponent. abstract int getXMLStatus() This method returns the EnumRequestStatus status of the current Component. abstract boolean handleRequest(RequestKeys keys) Handles a request. abstract boolean hasChanged() Verifies the state of the component has changed abstract boolean hasJustOpened() Verifies if the component has just been opened. abstract void initBean() Initialize the component after it's created and its properties initialized abstract void invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component. abstract boolean isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent. abstract boolean isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent abstract void prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup. abstract WebComponent removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent. abstract WebComponent removeChild(String key) removes a child WebComponent instance on the current WebComponent. abstract WebComponent searchChild(String key) Returns the child WebComponent instance specified by the key. abstract void setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of BeanContext on the current WebBean. abstract void setBeanContext(BeanContext beanContext) Sets an instance of BeanContext on the current WebBean. abstract void setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component abstract void setChanged(boolean value) Sets the changed state of the component. abstract void setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent. abstract void setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent abstract void setName(String name) Sets the name on the current WebComponent. abstract void setOutputFormat(int outputFormat) Sets the output format of EnumBeanOutputFormat of the current WebComponent. abstract void setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent. abstract void setPersistMode(int persistFlag) Sets the persist flag (EnumBeanPersistMode) of the current WebComponent. abstract void setRenderingFilter(Set renderingFilter) Sets the list of beans to render. abstract void setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance. abstract void setTargetBeanPath(String beanName) Define the base bean for this instance. abstract void setWebEventHandler(WebEventHandler handler) Sets a WebEventHandler on this component.