public class

ExpressionGenericTransform

extends AbstractAppTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ExpressionGenericTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The ExpressionGenericTransform class is a LayoutTransform which transforms an ExpressionBean object. It is also meant to be the base class for filter-related transforms, such as the FilterElementTransform for the filter editor. Many of the rendering methods on this interface are protected - the intention is to allow customizations to be done by extending this transform and overriding the methods which generate the appropriate output.

Summary

Nested Classes
class ExpressionGenericTransform.Context  
Constants
int DISPLAY_DYNAMIC_DATES_AS_DYNAMIC
int DISPLAY_DYNAMIC_DATES_AS_STATIC
String PARAM_NAME_OLD_EDIT_MODE
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameterImpl _allowAQElemsSearchParam
protected FormalParameterImpl _allowAQFormElemsToggleParam
protected FormalParameterImpl _allowAQSingleMultiFormToggleParam
protected FormalParameterImpl _allowMQSingleMultiQualToggleParam
protected WebEvent _applyEvent
protected FormalParameterImpl _clearFilterImageTxtParam
protected String _cssAddConditionNonEditable
protected String _cssBranchOperatorEditable
protected String _cssBranchOperatorNonEditable
protected String _cssConstant
protected String _cssConstantInError
protected String _cssConstantNonEditable
protected String _cssContent
protected String _cssEditableSubexpTable
protected String _cssFilterActionType
protected String _cssGlobal
protected String _cssGlobalContent
protected String _cssObjectName
protected String _cssObjectNameInError
protected String _cssObjectNameNonEditable
protected String _cssOperator
protected String _cssOperatorInError
protected String _cssOperatorNonEditable
protected String _cssText
protected String _cssTextEditable
protected String _cssTextNonEditable
protected String _cssTitle
protected FormalParameterImpl _defaultAttrQualModeParam
protected FormalParameterImpl _dynamicDateDisplayParam
protected FormalParameterImpl _expandEmbeddedFiltersParam
protected ExpressionBean _expressionBean
protected String _formName
protected FormalParameterImpl _formsCollectionParam
protected FormalParameterImpl _helpTopicNameParam This field is deprecated. No replacement.
protected FormalParameterImpl _hideIDFormsParam
protected WebEvent _multiEvent
protected FormalParameterImpl _separatorParam
protected FormalParameterImpl _showAddConditionButton
protected FormalParameterImpl _showDottedLineParam
protected FormalParameterImpl _showInlineAcceptCancelButtonsParam
protected FormalParameterImpl _stackSubexpressionsParam
protected FormalParameterImpl _submitButtonNameParam
protected FormalParameterImpl _titleParam
protected FormalParameter helpTopic
protected FormalParameter helpType
protected boolean renderForm
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ExpressionGenericTransform()
Public Methods
WebEvent getAddConditionEvent()
Returns the add condition event, which signals the intent to open the add wizard.
WebEvent getAddElementsEvent()
Returns the event to be used for the add elements operation.
WebEvent getApplyEvent()
Returns the event to be used for the apply button - this will handle synchronization of the ExpressionBean with the object it was retrieved from.
boolean getAutoApply()
Returns whether the auto-apply functionality is enabled.
WebEvent getCancelAllEvent()
Returns the cancel all event, which will cancel all un-applied changes.
WebEvent getCancelEvent()
Returns the event to be used for the cancel button - this will undo the currently edited subexpression's changes.
WebEvent getClearAllEvent()
Returns the clear all event, which signals that the user wishes to clear the whole subexpression.
WebEvent getCloseEvent()
Returns the event to be used for the close button.
Map getContentTableAttributes()
This method returns the attributes which are to be put on the table surrounding the main content of the filter.
WebEvent getCreateSubexpressionEvent()
Returns the create subexpression event, which signals that the user is creating a new subexpression.
String getCssName(WebObjectInfo object)
String getDescription()
Returns a textual description of the transform.
String getDisplayName(WebObjectInfo object)
WebEvent getEditEvent()
Returns the edit event, which signals the intent to edit an existing subexpression.
String getEditExpressionJS()
WebEvent getElemsSearchEvent()
Returns the event to be used for the element search action.
String getExpBeanPath()
This function is designed for ThresholdExpressionTransform.
ExpressionBean getExpressionBean()
Returns the expression bean.
WebEvent getFirstPageEvent()
Returns the event to be used for going to the first page of element browsing.
List getFlattenedContexFolderList(int contextId)
String getFlattenedContextFolderPath(int contextId)
WebEvent getHelpEvent()
Returns the event to be used for the help button.
WebEvent getLastPageEvent()
Returns the event to be used for going to the last page of element browsing.
Map getMainDivAttributes()
Returns the list of attributes to add to the main DIV that makes up the filter editor GUI.
WebEvent getNextPageEvent()
Returns the event to be used for going to the next page of element browsing.
String getOperatorName(int operatorType)
Checks for given WebOperator node function ID and returns corresponding localized function text.
int getPreferenceIntegerReplaceNull(String prefName, int nullReplace)
WebEvent getPrevPageEvent()
Returns the event to be used for going to the previous page of element browsing.
WebEvent getRemoveElementsEvent()
Returns the event to be used for the remove elements operation.
WebEvent getRestoreStateEvent()
Returns the restore state event based upon the subexpression being edited.
Class getSupportedBeanType()
Returns the supported bean type for this transform.
WebEvent getToggleAQFormElemsEvent()
Returns the event to toggle between form and elements qualifications.
WebEvent getToggleOperatorEvent()
Returns the event to toggle the logical operator of an expression (AND/OR/NOT, etc).
WebEvent getToggleQualExprEvent()
Returns the event to toggle between single and multiple-part qualificiation - for example, single metric and multi metric, or single form and multi form.
boolean includeOwnerInfo()
boolean includeTimeInfo()
void initializeCss()
This method initializes the CSS names used by the transform.
void initializeTransform(Transformable data)
This method overrides the superclass' initializeTransform method - this is called to pick up the reference to the Transformable object passed to the transform and to do initialization of the transform.
boolean isAddWizardRequested()
Returns whether the bean is requesting the display of the add wizard.
boolean isApplyCancelEnabled()
Returns whether the apply/cancel buttons should be shown.
boolean isAutoSynchronizeEnabled()
This method returns whether the GUI should synchronize the expression on the expression bean with its source upon every operation.
boolean isEditable()
Returns whether the user is allowed to edit this expression.
boolean isNotDhtml()
Used by layout to check for absence of DHTML mode.
boolean isShowObjectTags()
boolean isUpdateManagerEnabled()
This method can be overridden by child classes to signal whether or not to send all multiple event requests through the update manager.
void renderAddWizard(MarkupOutput out)
This method will render an HTML pull-down menu presenting a list of objects to qualify upon if the expression bean's edit mode is ExpressionEditModeSelectUnit.
void renderAddWizardButtons(MarkupOutput out)
This method renders the buttons for the add wizard.
void renderAddWizardDropdown(MarkupOutput out)
This method renders the object dropdown for the add wizard.
void renderAddWizardTransition(MarkupOutput out)
This method renders the transition between the rest of the filter and the add wizard (usually the word and).
void renderApplyCancelButtons(MarkupOutput out)
Function that displays apply and cancel buttons for the whole expression, when they are needed.
void renderCloseButton(MarkupOutput out)
This method will render the close button for the editor.
void renderContent(MarkupOutput out)
This method renders the content of the filter editor.
void renderEditorTitle(MarkupOutput out)
This method will simply render the title of the editor.
void renderEmptyFilterMessage(MarkupOutput out)
This method will check whether the filter that this transform is attempting to render is empty, and if it is, render a message saying that the filter is empty.
void renderFilterTree(MarkupOutput out)
This method will render the actual filter expression tree in the GUI.
void renderGenericValidationErrorMessage(MarkupOutput out)
If the expression bean has a validation error waiting on it, this method will render a generic error message.
void renderHeader(MarkupOutput out)
This method will render the header portion of the document, which includes the empty filter message, add condition button, close all button, and auto-apply button.
void renderHeaderAddCondition(MarkupOutput out)
This method will render the add condition link, normally in the header of the editor.
void renderHeaderAutoApply(MarkupOutput out)
This method will render the "auto apply enabled" button in the filter editor GUI.
void renderHeaderClearAll(MarkupOutput out)
This method will render the "clear all" button in the filter editor.
void renderHelpButton(MarkupOutput out)
This method will render the help button for the editor.
void renderSeparator(MarkupOutput out)
Renders the separator that is used to indent subexpressions.
void renderSpecificValidationErrorMessage(MarkupOutput out)
If the expression bean has a validation error waiting on it, this method will render the specific error message for that error.
void renderTitle(MarkupOutput out)
This method renders the title portion of the GUI.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
void addAttDetails(WebAttribute attr)
void addAttrsToTag(Map attrs, Tag tag)
void addClickOnAttrSelectorButton(InputTag inputTag, WebEvent toggleSingleExprEvent, boolean isMultiFormQual)
void addClickOnMetricSelectorButton(InputTag inputTag, WebEvent toggleMode, boolean isMetricExprQual)
void addEventHiddenInputs(ArrayList eventList)
void addOption(SelectTag tag, int value, String desc, int selectedValue)
List buildFlattenedList(int contextId, StringWrapper path)
int calculateBlockBegin()
boolean canEditOperator(WebNode leftNode, WebNode rightNode)
boolean canEditSubexpression(WebNode node)
Returns whether the subexpression at the current node is editable or not.
boolean canFilterOnUnit(WebObjectInfo oi)
This method determines if the current object is allowed to be filtered upon.
boolean canMoveDown(WebNode node)
boolean canMoveUp(WebNode node)
boolean canSelectElements(WebAttribute webAttribute)
This method determines whether the attribute requires a lookup table to support elements qualification.
boolean canShowMetricTextOperators()
boolean canToggleAQFormElements(WebAttribute webAttribute)
This method determines whether the user is allowed to toggle between attribute form and elements qualfication.
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting requested attributes
void generateDeleteSubExpressionClickJS(String key, WebEvent deleteEvent, StringBuffer onClickJS)
This method will render the JavaScript necessary to delete a sub expression.
final String generateMultiEventArgumentString(WebEvent[] eventList, String[][] argsLists, boolean restoreState)
Generates the multiple event argument string for the given event list, with the given argument lists.
final String generateMultiEventArgumentString(WebEvent event, String[] args, boolean restoreState)
Generates the multiple event argument string for the given event, with the given arguments.
Tag generateOptionTag(String desc, String value, boolean selected)
final void generateUpdateManagerEventJSString(StringBuffer buf, String beanPath, WebEvent event, String[] args, boolean restoreState)
Generates the javascript for the onclick tag that is necessary to invoke the given event via the update manager.
WebEvent getAddEmbeddedPromptEvent()
Map getAttributesForAcceptButton()
This method will return any HTML attributes that should be added to the accept button for a subexpression being edited.
Map getAttributesForPromptButton()
WebFolder getAvailableObjectsFolder()
Returns the list of "available" objects to be used for the add wizard or for an attribute-to-attribute or metric-to-metric qualificiation.
String getBeanName()
Returns the main bean's name.
String getBeanPath()
Returns the main bean's path.
int getBeanStateLevel()
Returns the state level that the bean needs to be saved in for the transform to work properly.
String getBeginJavaScriptCall()
Returns the client-side code necessary for executing js in links.
String getBoneId()
Returns the id to be used for the JavaScript bone.
String getConstantValue(WebNode parent, int ix, String defaultValue)
String getContentTableClass()
Returns the CSS class recommended for the table containing the expression.
WebEvent getDeleteEvent()
Returns the delete subexpression event.
WebEvent getEditEmbeddedPromptEvent()
Editor getEditor()
Returns an Editor object, which is used to render help/close buttons.
String getEmptyFilterMessage()
Returns the message that should be used if the filter is empty.
ExpressionBean getEventTargetExpressionBean()
Returns the expression bean for getting events.
int getFilterType()
Returns the filter type, from EnumFilterTypes.
String getFormName()
WebAttributeForms getForms(WebAttribute att, int formsCollectionType)
String getImageFolder()
Returns the folder that images are expected to be stored in.
WebEvent getMQAcceptEvent(boolean isMetricExprQual)
String getMetricName(WebShortcutNode shortcutNode)
WebShortcutNode getMetricShortuctNode(WebNode node)
String getObjectAlias(WebObjectInfo ob)
Attempts to find the best object alias to use for the given object.
String getOnClickJavaScript()
Returns any javascript to be excuted when the user clicks the element it's assigned to.
String getPromptButtonSourcePath()
WebEvent getRemovePromptEvent()
String getSeparator()
String getSpecailBeginJavaScriptCall()
Returns the client-side code necessary for executing js in links.
String getTooltipReportObjects()
This function return list of all metrics in workingset for tooltip in metric expression when view mode in on.
String getValidateJavaScript()
WebWorkingSet getWorkingSet()
Returns the working set object, if the filter is a report filter.
void initExpressionBeanTransform(ExpressionBean expBean)
This method captures the reference to the expression bean and does some other initialization-related routines.
void initializeCartSettings(Cart cart, WebEvent acceptEvent, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)
This method will initialize the shopping cart object used to render an attribute element list qualification.
void initializeCartSettings(Cart cart, String selectedAnswerListName, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)
boolean isFilterEditorFrameEmpty()
This method evaluates whether the filter editor frame is empty.
boolean isFilterEmpty(WebExpression expr)
Returns whether the given filter expression is empty.
boolean isItemKeptInCartAvailable()
Indicates preference value for whether or not to keep item in cart's available list.
boolean isMetricDimtyTooltipEnabled()
Returns whether the metric dimensionality should be rendered as a tooltip in the expression.
boolean isObjectInTemplate(WebShortcutNode shortcutNode)
boolean isStackedSubexpEnabled()
boolean isSubexpressionInError(WebNode node)
Returns whether the subexpression at the current node is in error or not.
boolean isViewFilter()
Returns whether this expression refers to a report's view filter.
boolean isViewReport()
Cart newCart()
TransformContext newContext()
Creates a new instance of a TransformContext.
ExpressionFilterTransform newFet()
void renderAQEditMode(MarkupOutput out, WebNode node, int level)
This method will render an attribute qualification which is being edited by the user.
void renderAQListCart(WebNode node, Tag tableTag, WebEvent acceptEvent)
void renderAQListEditMode(MarkupOutput out, WebNode node, int level)
This method renders an attribute qualficiation subexpression which is being edited in list mode - i.e.
void renderAQListFirstRow(WebOperatorNode node, Tag tableTag, WebEvent acceptEvent)
void renderAQOperatorOption(MarkupOutput mo, int function, int descriptorId, int currentFunction)
void renderAQOperatorOptions(MarkupOutput mo, int currentFunction, boolean unitComparison)
void renderAQQualifyAttrForms(MarkupOutput out, WebNode operatorNode, WebFormShortcutNode formShortcutNode, WebEvent acceptEvent)
This method will render the list of attribute forms to qualify upon for an attribute form qualfication that is being edited.
void renderAQQualifyAttrForms(MarkupOutput out, WebNode operatorNode, WebFormShortcutNode formShortcutNode, WebEvent acceptEvent, boolean isConstPrompted)
void renderAQQualifyConstantTextbox(MarkupOutput out, int function, String value, WebEvent acceptEvent)
This method will render the constant textbox for an attribute form to constant value qualification.
void renderAQQualifyConstantTextbox(MarkupOutput out, int function, String value, WebEvent acceptEvent, boolean isDisabledByConstPrompt)
void renderAQQualifyEditMode(MarkupOutput out, WebNode node, int level, boolean isMultiFormQual)
This method will render an attribute form qualfication subexpression that is currently being edited.
void renderAQQualifyFunctions(MarkupOutput out, int function, boolean isMultiFormQual, WebEvent acceptEvent)
This method will render a list of functions that can be used to render an attribute form qualficiation subexpression in edit mode.
void renderAQQualifyFunctions(MarkupOutput out, int function, boolean isMultiFormQual, WebEvent acceptEvent, boolean isConstPrompted)
void renderAQQualifyUnit(MarkupOutput out, WebNode node, WebEvent accpetEvent)
void renderAQQualifyUnitComparison(MarkupOutput out, String selectedAttributeID, String selectedFormID, WebEvent acceptEvent)
This method will render the right-side pulldown of attribute forms for an attribute form to attribute form qualification.
void renderAcceptButton(MarkupOutput out, WebEvent acceptEvent, String[] eventArgList, boolean isDefault)
void renderCancelButton(MarkupOutput out)
Renders the Cancel button for the wait page.
void renderConstantPromptArea(MarkupOutput out, WebPrompt constPrompt, int ndKey)
This method will render an existing constant prompt in a subexpression that is being edited.
void renderDescendantOptions(WebOperatorNode node, Tag tableTag, WebEvent acceptEvent)
void renderDottedLine(MarkupOutput out)
Renders a dotted lined to be used as separator between edit forms and filter expression tree
void renderDownButton(MarkupOutput mainOut, WebNode node)
void renderErrorMessage(MarkupOutput out, String imageTitle, String errorMessage)
void renderEventHiddenInputs(MarkupOutput out)
This method will render all of the hidden inputs for the events that will be used within the expression transform.
void renderExpression(MarkupOutput out)
void renderFilterNode(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This is the method which renders a single node within the filter.
void renderJavascript(MarkupOutput out)
This method renders all javascript that will be necessary for the ExpressionGenericTransform to work correctly.
void renderMQConstantTextbox(MarkupOutput out, WebEvent acceptEvent, String constValue, int function)
This method renders the constant textbox for a metric qualification subexpression.
void renderMQEditMode(MarkupOutput out, WebNode node, int level)
This function will render the subexpression for a metric qualfiication which is being edited by the user.
void renderMQFunctions(MarkupOutput out, WebEvent acceptEvent, int function, int functionType, boolean isMetricExprQual, boolean isConstPrompted)
void renderMQOperatorOption(MarkupOutput mo, int function, int functionType, int descriptorId, int currentFunction, int currentFunctionType)
void renderMQOperatorOption(MarkupOutput mo, int function, int descriptorId, int currentFunction)
void renderMQOperatorOptions(MarkupOutput mo, int currentFunction, int currentFunctionType, boolean bUnitComparison)
void renderMQUnitComparison(MarkupOutput out, String metricID, WebEvent acceptEvent)
This method will render the unit comparison list for a metric-to-metric qualfication that is currently being edited..
void renderMeNodeEditMode(MarkupOutput out, WebNode node, int level)
This function will render the subexpression for a me node expression which is being edited by the user.
void renderMeNodeQualFunctions(MarkupOutput out, WebEvent acceptEvent, int function, int functionType)
void renderMeNodeQualOperatorOptions(MarkupOutput mo, int currentFunction, int currentFunctionType)
void renderOperator(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, boolean isReportLimit, MarkupOutput mainOut, boolean useEditMode)
void renderOperator(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, int level, boolean isReportLimit)
This method renders the given operator node.
void renderOperatorEditMode(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode)
This method renders an operator in edit mode.
void renderOperatorViewMode(MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, boolean isReportLimit)
This method will render an operator node in view mode.
void renderPromptButton(MarkupOutput out, int promptType, String inputID, boolean isDisabled)
void renderPromptButton(MarkupOutput out, int promptType, String inputID, boolean isDisabled, boolean isHidden)
void renderRemoveSubexpressionButton(MarkupOutput out, WebNode node, boolean isEditableFilterExpr)
void renderSubExpression(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This method renders a subexpression of the expression.
void renderSubExpressionEditMode(MarkupOutput out, WebNode node, int level)
This function renders a subexpression which is currently being edited by the user.
void renderSubExpressionViewMode(MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)
This is the generic method that renders a non-branch subexpression in view mode.
void renderSubexpressionBodyViewMode(WebExpression expr, WebNode node, int level, boolean isReportLimit, boolean isEditableFilterExpr, MarkupOutput mainOut)
@deprecated
void renderSubexpressionBodyViewMode(MarkupOutput mainOut, WebExpression expr, WebNode node, int level, boolean isReportLimit, boolean isEditableFilterExpr)
void renderUpAndDownButtons(WebNode node, boolean isEditableFilterExpr, MarkupOutput mainOut)
This method is deprecated. Replaced by renderUpAndDownButtons(MarkupOutput mainOut, ....)
void renderUpAndDownButtons(MarkupOutput mainOut, WebNode node, boolean isEditableFilterExpr)
void renderUpButton(WebNode node, MarkupOutput mainOut)
This method is deprecated. Replaced by renderUpButtom(MarkupOutput,....)
void renderUpButton(MarkupOutput mainOut, WebNode node)
void renderXDAMetricSelectorButton(MarkupOutput out)
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
void setFormName(String name)
boolean shallRenderAcceptCancell()
boolean shallRenderForm(WebAttributeForm form)
boolean shouldShowObject(WebDisplayUnit unit)
Indicate if the unit should be shown.
boolean showCloseButton()
Returns whether to show a close button.
boolean supportsPromptEditor()
boolean useWorkingSetForFormLookup()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final int DISPLAY_DYNAMIC_DATES_AS_DYNAMIC

Constant Value: 1 (0x00000001)

public static final int DISPLAY_DYNAMIC_DATES_AS_STATIC

Constant Value: 0 (0x00000000)

protected static final String PARAM_NAME_OLD_EDIT_MODE

Constant Value: "oldEditMode"

Fields

protected FormalParameterImpl _allowAQElemsSearchParam

protected FormalParameterImpl _allowAQFormElemsToggleParam

protected FormalParameterImpl _allowAQSingleMultiFormToggleParam

protected FormalParameterImpl _allowMQSingleMultiQualToggleParam

protected WebEvent _applyEvent

protected FormalParameterImpl _clearFilterImageTxtParam

protected String _cssAddConditionNonEditable

protected String _cssBranchOperatorEditable

protected String _cssBranchOperatorNonEditable

protected String _cssConstant

protected String _cssConstantInError

protected String _cssConstantNonEditable

protected String _cssContent

protected String _cssEditableSubexpTable

protected String _cssFilterActionType

protected String _cssGlobal

protected String _cssGlobalContent

protected String _cssObjectName

protected String _cssObjectNameInError

protected String _cssObjectNameNonEditable

protected String _cssOperator

protected String _cssOperatorInError

protected String _cssOperatorNonEditable

protected String _cssText

protected String _cssTextEditable

protected String _cssTextNonEditable

protected String _cssTitle

protected FormalParameterImpl _defaultAttrQualModeParam

protected FormalParameterImpl _dynamicDateDisplayParam

protected FormalParameterImpl _expandEmbeddedFiltersParam

protected ExpressionBean _expressionBean

protected String _formName

protected FormalParameterImpl _formsCollectionParam

protected FormalParameterImpl _helpTopicNameParam

This field is deprecated.
No replacement.

protected FormalParameterImpl _hideIDFormsParam

protected WebEvent _multiEvent

protected FormalParameterImpl _separatorParam

protected FormalParameterImpl _showAddConditionButton

protected FormalParameterImpl _showDottedLineParam

protected FormalParameterImpl _showInlineAcceptCancelButtonsParam

protected FormalParameterImpl _stackSubexpressionsParam

protected FormalParameterImpl _submitButtonNameParam

protected FormalParameterImpl _titleParam

protected FormalParameter helpTopic

protected FormalParameter helpType

protected boolean renderForm

Public Constructors

public ExpressionGenericTransform ()

Public Methods

public WebEvent getAddConditionEvent ()

Returns the add condition event, which signals the intent to open the add wizard.

Returns
  • The add condition event.

public WebEvent getAddElementsEvent ()

Returns the event to be used for the add elements operation.

Returns
  • The add elements event.

public WebEvent getApplyEvent ()

Returns the event to be used for the apply button - this will handle synchronization of the ExpressionBean with the object it was retrieved from.

Returns
  • The apply event.

public boolean getAutoApply ()

Returns whether the auto-apply functionality is enabled. If this is true, the transform will render the GUI such that it expects that every operation will apply changes to the original expression automatically.

Returns
  • Whether auto-apply is enabled.

public WebEvent getCancelAllEvent ()

Returns the cancel all event, which will cancel all un-applied changes.

Returns
  • The cancel all event.

public WebEvent getCancelEvent ()

Returns the event to be used for the cancel button - this will undo the currently edited subexpression's changes.

Returns
  • The cancel event.

public WebEvent getClearAllEvent ()

Returns the clear all event, which signals that the user wishes to clear the whole subexpression.

Returns
  • The clear all event.

public WebEvent getCloseEvent ()

Returns the event to be used for the close button.

Returns
  • The close event.

public Map getContentTableAttributes ()

This method returns the attributes which are to be put on the table surrounding the main content of the filter. This can be overridden to change the attributes which are on the table.

Returns
  • A java.util.Map object whose keys are the attribute names, and the values are the attribute values. Both are String-typed.

public WebEvent getCreateSubexpressionEvent ()

Returns the create subexpression event, which signals that the user is creating a new subexpression.

Returns
  • The create subexpression event.

public String getCssName (WebObjectInfo object)

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public String getDisplayName (WebObjectInfo object)

public WebEvent getEditEvent ()

Returns the edit event, which signals the intent to edit an existing subexpression.

Returns
  • The edit event.

public String getEditExpressionJS ()

public WebEvent getElemsSearchEvent ()

Returns the event to be used for the element search action.

Returns
  • The elements search event.

public String getExpBeanPath ()

This function is designed for ThresholdExpressionTransform. It just return bean path the same as getBeanPath() in this class. and will be overridden in ThresholdExpressionTransform

public ExpressionBean getExpressionBean ()

Returns the expression bean. This should be used by derived classes to retrieve the expression bean being rendered.

Returns

public WebEvent getFirstPageEvent ()

Returns the event to be used for going to the first page of element browsing.

Returns
  • The first page event.

public List getFlattenedContexFolderList (int contextId)

public String getFlattenedContextFolderPath (int contextId)

public WebEvent getHelpEvent ()

Returns the event to be used for the help button.

Returns
  • The help event.

public WebEvent getLastPageEvent ()

Returns the event to be used for going to the last page of element browsing.

Returns
  • The last page event.

public Map getMainDivAttributes ()

Returns the list of attributes to add to the main DIV that makes up the filter editor GUI. These attributes must primarily be included for the javascript concerning the filter editor to work properly.

Returns
  • A java.util.Map object whose keys are the attribute names, and the values are the attribute values. Both are String-typed.

public WebEvent getNextPageEvent ()

Returns the event to be used for going to the next page of element browsing.

Returns
  • The next page event.

public String getOperatorName (int operatorType)

Checks for given WebOperator node function ID and returns corresponding localized function text.

Returns
  • Operator name

public int getPreferenceIntegerReplaceNull (String prefName, int nullReplace)

public WebEvent getPrevPageEvent ()

Returns the event to be used for going to the previous page of element browsing.

Returns
  • The previous page event.

public WebEvent getRemoveElementsEvent ()

Returns the event to be used for the remove elements operation.

Returns
  • The remove elements event.

public WebEvent getRestoreStateEvent ()

Returns the restore state event based upon the subexpression being edited.

Returns
  • The restore state event to use to restore state changes within the filter editor from the last rendering.

public Class getSupportedBeanType ()

Returns the supported bean type for this transform.

Returns
  • A Class object representing the bean type this transform supports.

public WebEvent getToggleAQFormElemsEvent ()

Returns the event to toggle between form and elements qualifications.

Returns
  • The toggle event for toggling between form and element qualificiations.

public WebEvent getToggleOperatorEvent ()

Returns the event to toggle the logical operator of an expression (AND/OR/NOT, etc).

Returns
  • The toggle event for toggling the logical operator of an expression.

public WebEvent getToggleQualExprEvent ()

Returns the event to toggle between single and multiple-part qualificiation - for example, single metric and multi metric, or single form and multi form.

Returns
  • The toggle event for toggling between single and multiple qualification.

public boolean includeOwnerInfo ()

public boolean includeTimeInfo ()

public void initializeCss ()

This method initializes the CSS names used by the transform. It overrides the initializeCss method on AbstractAppTransform.

public void initializeTransform (Transformable data)

This method overrides the superclass' initializeTransform method - this is called to pick up the reference to the Transformable object passed to the transform and to do initialization of the transform. If this method is overridden, then it must be called by the overriding method in order for the transform to work properly.

Parameters
data The Transformable object that is being transformed upon.

public boolean isAddWizardRequested ()

Returns whether the bean is requesting the display of the add wizard.

Returns
  • True if the add wizard should be shown, false otherwise.

public boolean isApplyCancelEnabled ()

Returns whether the apply/cancel buttons should be shown.

Returns
  • True if the apply/cancel buttons should be shown, false otherwise.

public boolean isAutoSynchronizeEnabled ()

This method returns whether the GUI should synchronize the expression on the expression bean with its source upon every operation. If this is false, then the apply/cancel buttons will be active.

Returns
  • Whether auto-synchronize is enabled for this transform.

public boolean isEditable ()

Returns whether the user is allowed to edit this expression.

Returns
  • True if the expression is editable, false otherwise.

public boolean isNotDhtml ()

Used by layout to check for absence of DHTML mode.

public boolean isShowObjectTags ()

public boolean isUpdateManagerEnabled ()

This method can be overridden by child classes to signal whether or not to send all multiple event requests through the update manager. By default, this is false, meaning that the update manager should not be used.

Returns
  • True if the update manager is enabled, false otherwise.

public void renderAddWizard (MarkupOutput out)

This method will render an HTML pull-down menu presenting a list of objects to qualify upon if the expression bean's edit mode is ExpressionEditModeSelectUnit.

Parameters
out The MarkupOutput object to render the output to.

public void renderAddWizardButtons (MarkupOutput out)

This method renders the buttons for the add wizard.

Parameters
out The MarkupOutput object to render the output to.

public void renderAddWizardDropdown (MarkupOutput out)

This method renders the object dropdown for the add wizard.

Parameters
out The MarkupOutput object to render the output to.

public void renderAddWizardTransition (MarkupOutput out)

This method renders the transition between the rest of the filter and the add wizard (usually the word and).

Parameters
out The MarkupOutput object to render the output to.

public void renderApplyCancelButtons (MarkupOutput out)

Function that displays apply and cancel buttons for the whole expression, when they are needed.

Parameters
out The MarkupOutput object to render the output to.

public void renderCloseButton (MarkupOutput out)

This method will render the close button for the editor. To find the event to associate with this button, it will call getCloseEvent. If that method returns null, then no close button will be rendered.

Parameters
out The MarkupOutput object to render the output to.

public void renderContent (MarkupOutput out)

This method renders the content of the filter editor. This is basically the full body of the filter, including the add wizard, the filter expression itself, and the apply/cancel buttons.

Parameters
out The MarkupOutput object to render the output to.

public void renderEditorTitle (MarkupOutput out)

This method will simply render the title of the editor.

Parameters
out The MarkupOutput object to render the output to.

public void renderEmptyFilterMessage (MarkupOutput out)

This method will check whether the filter that this transform is attempting to render is empty, and if it is, render a message saying that the filter is empty. If the filter is not empty, then nothing will be rendered.

Parameters
out The MarkupOutput object to render the output to.

public void renderFilterTree (MarkupOutput out)

This method will render the actual filter expression tree in the GUI. This is the lowest-level method that can be called by the layout to render the actual expression itself.

Parameters
out The MarkupOutput object to render the output to.

public void renderGenericValidationErrorMessage (MarkupOutput out)

If the expression bean has a validation error waiting on it, this method will render a generic error message. If there is no validation error waiting, then this method will do nothing.

Parameters
out The MarkupOutput object to render the output to.

public void renderHeader (MarkupOutput out)

This method will render the header portion of the document, which includes the empty filter message, add condition button, close all button, and auto-apply button.

Parameters
out The MarkupOutput object to render the output to.

public void renderHeaderAddCondition (MarkupOutput out)

This method will render the add condition link, normally in the header of the editor.

Parameters
out The MarkupOutput object to render the output to.

public void renderHeaderAutoApply (MarkupOutput out)

This method will render the "auto apply enabled" button in the filter editor GUI. Note that by default, this method is not implemented, and must be overridden by child classes if it is to do anything. This is because this only makes sense in certain filter editing contexts.

Parameters
out The MarkupOutput object to render the output to.

public void renderHeaderClearAll (MarkupOutput out)

This method will render the "clear all" button in the filter editor.

Parameters
out The MarkupOutput object to render the output to.

public void renderHelpButton (MarkupOutput out)

This method will render the help button for the editor. To find the event to associate with this button, it will call getHelpEvent. If that method returns null, then no help button will be rendered.

Parameters
out The MarkupOutput object to render the output to.

public void renderSeparator (MarkupOutput out)

Renders the separator that is used to indent subexpressions.

Parameters
out The MarkupOutput object to render the output to.

public void renderSpecificValidationErrorMessage (MarkupOutput out)

If the expression bean has a validation error waiting on it, this method will render the specific error message for that error. If there is no validation error waiting, then this method will do nothing.

Parameters
out The MarkupOutput object to render the output to.

public void renderTitle (MarkupOutput out)

This method renders the title portion of the GUI. This includes the title, empty filter message, help/close buttons, and the options at the top of the page such as Add Condition and Clear All.

Parameters
out The MarkupOutput object to render the output to.

public void transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Parameters
out output by this transform

Protected Methods

protected void addAttDetails (WebAttribute attr)

protected void addAttrsToTag (Map attrs, Tag tag)

protected void addClickOnAttrSelectorButton (InputTag inputTag, WebEvent toggleSingleExprEvent, boolean isMultiFormQual)

protected void addClickOnMetricSelectorButton (InputTag inputTag, WebEvent toggleMode, boolean isMetricExprQual)

protected void addEventHiddenInputs (ArrayList eventList)

protected void addOption (SelectTag tag, int value, String desc, int selectedValue)

protected List buildFlattenedList (int contextId, StringWrapper path)

protected int calculateBlockBegin ()

protected boolean canEditOperator (WebNode leftNode, WebNode rightNode)

protected boolean canEditSubexpression (WebNode node)

Returns whether the subexpression at the current node is editable or not.

Returns
  • Whether the subexpression at the current node is editable or not.

protected boolean canFilterOnUnit (WebObjectInfo oi)

This method determines if the current object is allowed to be filtered upon.

Parameters
oi The WebObjectInfo unit which needs to be shown in the filterable drop down list.
Returns
  • true if the current object is allowed to be filtered upon.

protected boolean canMoveDown (WebNode node)

protected boolean canMoveUp (WebNode node)

protected boolean canSelectElements (WebAttribute webAttribute)

This method determines whether the attribute requires a lookup table to support elements qualification.

Parameters
webAttribute The attribute on which we have to decide if it requires a lookup table to support elements qualification.
Returns
  • true if the attribute requires a lookup table to support elements qualification.

protected boolean canShowMetricTextOperators ()

protected boolean canToggleAQFormElements (WebAttribute webAttribute)

This method determines whether the user is allowed to toggle between attribute form and elements qualfication.

Parameters
webAttribute The attribute on which we have to decide if we should allow the toggle between attribute form and elements qualfication.
Returns
  • true if the user is allowed to toggle between attribute form and elements qualfication.

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting requested attributes

Parameters
event WebEvent instance base for creating the anchor
Returns
  • AnchorTag intitialized instance with the information as provided

protected void generateDeleteSubExpressionClickJS (String key, WebEvent deleteEvent, StringBuffer onClickJS)

This method will render the JavaScript necessary to delete a sub expression.

Parameters
onClickJS The MarkupOutput object to render the output to.

protected final String generateMultiEventArgumentString (WebEvent[] eventList, String[][] argsLists, boolean restoreState)

Generates the multiple event argument string for the given event list, with the given argument lists. If restoreState is true, then the appropriate event to restore state will be appended to the beginning of the given events.

Parameters
eventList The list of events.
argsLists The list of argument lists, in the same order as the event list.
restoreState Whether to include the restore state event.
Returns
  • The string representing the multiple event argument.

protected final String generateMultiEventArgumentString (WebEvent event, String[] args, boolean restoreState)

Generates the multiple event argument string for the given event, with the given arguments. If restoreState is true, then the appropriate event to restore state will be appended to the beginning of the given event.

Parameters
event The event.
args The argument list - argument name/value pairs in a flat array (i.e. name1, value1, name2, value2,...).
restoreState Whether to include the restore state event.
Returns
  • The string representing the multiple event argument.

protected Tag generateOptionTag (String desc, String value, boolean selected)

protected final void generateUpdateManagerEventJSString (StringBuffer buf, String beanPath, WebEvent event, String[] args, boolean restoreState)

Generates the javascript for the onclick tag that is necessary to invoke the given event via the update manager. A String representing the javascript function call(s) necessary to invoke the given event.

Parameters
beanPath The path of the bean the event is being run upon.
event The WebEvent object representing the event to be run.
args An argument list consisting of {event ID1, eventValue1, eventID2, eventValue2,...}. This can be null if there are no arugments.
restoreState If this is true, then the best known restore state event will be added to the event.

protected WebEvent getAddEmbeddedPromptEvent ()

protected Map getAttributesForAcceptButton ()

This method will return any HTML attributes that should be added to the accept button for a subexpression being edited. This can be used to add javascript to the accept button, which can be used to assist customizations.

Returns
  • A java.util.Map containing attribute name-attribute value String pairs describing the attributes to add to the accept button.

protected Map getAttributesForPromptButton ()

protected WebFolder getAvailableObjectsFolder ()

Returns the list of "available" objects to be used for the add wizard or for an attribute-to-attribute or metric-to-metric qualificiation.

Returns
  • A WebFolder with the list of available objects.

protected String getBeanName ()

Returns the main bean's name.

Returns
  • The expression bean's name.

protected String getBeanPath ()

Returns the main bean's path.

Returns
  • The expression bean's path.

protected int getBeanStateLevel ()

Returns the state level that the bean needs to be saved in for the transform to work properly.

Returns
  • The bean state level required for the ExpressionBean.

protected String getBeginJavaScriptCall ()

Returns the client-side code necessary for executing js in links. Also makes a call to getOnClickJavaScript.

protected String getBoneId ()

Returns the id to be used for the JavaScript bone.
This method is used by the renderRegisterBone method to indicate the id of the bone html element.

Returns
  • String

protected String getConstantValue (WebNode parent, int ix, String defaultValue)

protected String getContentTableClass ()

Returns the CSS class recommended for the table containing the expression.

Returns
  • The recommended content table CSS class.

protected WebEvent getDeleteEvent ()

Returns the delete subexpression event.

Returns
  • The delete event.

protected WebEvent getEditEmbeddedPromptEvent ()

protected Editor getEditor ()

Returns an Editor object, which is used to render help/close buttons.

Returns
  • An editor object.

protected String getEmptyFilterMessage ()

Returns the message that should be used if the filter is empty.

protected ExpressionBean getEventTargetExpressionBean ()

Returns the expression bean for getting events. This should be used by derived classes to retrieve the expression bean that events should target.

Returns

protected int getFilterType ()

Returns the filter type, from EnumFilterTypes.

Returns
  • The filter type of the expression.

protected String getFormName ()

protected WebAttributeForms getForms (WebAttribute att, int formsCollectionType)

Throws
IllegalArgumentException
UnsupportedOperationException

protected String getImageFolder ()

Returns the folder that images are expected to be stored in.

Returns
  • The image folder.

protected WebEvent getMQAcceptEvent (boolean isMetricExprQual)

protected String getMetricName (WebShortcutNode shortcutNode)

protected WebShortcutNode getMetricShortuctNode (WebNode node)

protected String getObjectAlias (WebObjectInfo ob)

Attempts to find the best object alias to use for the given object.

Parameters
ob The object whose alias will be returned.
Returns
  • The alias to use for the object.

protected String getOnClickJavaScript ()

Returns any javascript to be excuted when the user clicks the element it's assigned to. This is used by the mstrThresholdExpressionEditor bone to tell the advanced thresholds editor to notify the ThresholdEditorBean that the expression is about to be edited.

protected String getPromptButtonSourcePath ()

protected WebEvent getRemovePromptEvent ()

protected String getSeparator ()

protected String getSpecailBeginJavaScriptCall ()

Returns the client-side code necessary for executing js in links. Also makes a call to getOnClickJavaScript. It also adds a call to call getValidateJavaScript.

protected String getTooltipReportObjects ()

This function return list of all metrics in workingset for tooltip in metric expression when view mode in on.

Returns
  • String

protected String getValidateJavaScript ()

protected WebWorkingSet getWorkingSet ()

Returns the working set object, if the filter is a report filter. Otherwise, returns null.

Returns
  • A WebWorkingSet object if the filter is a report filter, or null otherwise.

protected void initExpressionBeanTransform (ExpressionBean expBean)

This method captures the reference to the expression bean and does some other initialization-related routines. Note that subclasses of this transform must either:

  1. Call initializeTransform with an ExpressionBean object.
  2. Call this method.

Parameters
expBean The ExpressionBean to transform.

protected void initializeCartSettings (Cart cart, WebEvent acceptEvent, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)

This method will initialize the shopping cart object used to render an attribute element list qualification.

Parameters
cart The Cart object being initialized.
acceptEvent The event to use to accept the qualficiation.
elemsBlockBegin The blockBegin parameter for the available elements to retrieve.
elemsBlockCount The blockBegin parameter for the available elements to retrieve.
totalElements The total number of elements in the element list of available elements.

protected void initializeCartSettings (Cart cart, String selectedAnswerListName, int elemsBlockBegin, int elemsBlockCount, int totalElements, WebAttribute attr)

protected boolean isFilterEditorFrameEmpty ()

This method evaluates whether the filter editor frame is empty. If this is true, then the renderEmptyFilterMessage method will render a message.

Returns
  • Whether the filter editor frame is empty.

protected boolean isFilterEmpty (WebExpression expr)

Returns whether the given filter expression is empty.

Parameters
expr The expression to evaluate.
Returns
  • True if the given expression is empty, false otherwise.

protected boolean isItemKeptInCartAvailable ()

Indicates preference value for whether or not to keep item in cart's available list.

Returns
  • boolean true if preference is on.

protected boolean isMetricDimtyTooltipEnabled ()

Returns whether the metric dimensionality should be rendered as a tooltip in the expression.

Returns
  • Whether to show the metric dimensionality in a tooltip.

protected boolean isObjectInTemplate (WebShortcutNode shortcutNode)

protected boolean isStackedSubexpEnabled ()

protected boolean isSubexpressionInError (WebNode node)

Returns whether the subexpression at the current node is in error or not.

Returns
  • Whether the subexpression at the current node is in error or not.

protected boolean isViewFilter ()

Returns whether this expression refers to a report's view filter.

Returns
  • True if the expression refers to a view filter, false otherwise.

protected boolean isViewReport ()

Returns
  • whether the report is a view report

protected Cart newCart ()

protected TransformContext newContext ()

Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.

protected ExpressionFilterTransform newFet ()

protected void renderAQEditMode (MarkupOutput out, WebNode node, int level)

This method will render an attribute qualification which is being edited by the user. It will render the common elements to all attribute qualfications then delegate to more specific rendering methods.

Parameters
out The MarkupOutput object to render the output to.
node The node being rendered.
level The depth of the node in the expression tree.

protected void renderAQListCart (WebNode node, Tag tableTag, WebEvent acceptEvent)

protected void renderAQListEditMode (MarkupOutput out, WebNode node, int level)

This method renders an attribute qualficiation subexpression which is being edited in list mode - i.e. the attribute's elements are being qualified upon.

Parameters
out The MarkupOutput object to render the output to.
node The node being edited.
level The depth of the subexpression in the tree.

protected void renderAQListFirstRow (WebOperatorNode node, Tag tableTag, WebEvent acceptEvent)

protected void renderAQOperatorOption (MarkupOutput mo, int function, int descriptorId, int currentFunction)

protected void renderAQOperatorOptions (MarkupOutput mo, int currentFunction, boolean unitComparison)

protected void renderAQQualifyAttrForms (MarkupOutput out, WebNode operatorNode, WebFormShortcutNode formShortcutNode, WebEvent acceptEvent)

This method will render the list of attribute forms to qualify upon for an attribute form qualfication that is being edited.

Parameters
out The MarkupOutput object to render the output to.
operatorNode The node being rendered.
formShortcutNode The form shortcut node representing the current selection.
acceptEvent The event that is used to accept the qualification.

protected void renderAQQualifyAttrForms (MarkupOutput out, WebNode operatorNode, WebFormShortcutNode formShortcutNode, WebEvent acceptEvent, boolean isConstPrompted)

protected void renderAQQualifyConstantTextbox (MarkupOutput out, int function, String value, WebEvent acceptEvent)

This method will render the constant textbox for an attribute form to constant value qualification.

Parameters
out The MarkupOutput object to render the output to.
function The currently chosen function.
value The current value of the constant node.
acceptEvent The event to use to accept the qualification.

protected void renderAQQualifyConstantTextbox (MarkupOutput out, int function, String value, WebEvent acceptEvent, boolean isDisabledByConstPrompt)

protected void renderAQQualifyEditMode (MarkupOutput out, WebNode node, int level, boolean isMultiFormQual)

This method will render an attribute form qualfication subexpression that is currently being edited.

Parameters
out The MarkupOutput object to render the output to.
node The node currently being rendered.
level The level of the currently rendered node within its expression tree.
isMultiFormQual Whether this attribute form qualficiation is a form to form qualification or a form to constant qualificiation.

protected void renderAQQualifyFunctions (MarkupOutput out, int function, boolean isMultiFormQual, WebEvent acceptEvent)

This method will render a list of functions that can be used to render an attribute form qualficiation subexpression in edit mode.

Parameters
out The MarkupOutput object to render the output to.
function The currently selected function.
isMultiFormQual Whether this subexpression is a form-to-form qualficiation or form-to-constant qualification.
acceptEvent The event that should be used to accept the qualification.

protected void renderAQQualifyFunctions (MarkupOutput out, int function, boolean isMultiFormQual, WebEvent acceptEvent, boolean isConstPrompted)

protected void renderAQQualifyUnit (MarkupOutput out, WebNode node, WebEvent accpetEvent)

protected void renderAQQualifyUnitComparison (MarkupOutput out, String selectedAttributeID, String selectedFormID, WebEvent acceptEvent)

This method will render the right-side pulldown of attribute forms for an attribute form to attribute form qualification.

Parameters
out The MarkupOutput object to render the output to.
acceptEvent The event used to accept the qualification.

protected void renderAcceptButton (MarkupOutput out, WebEvent acceptEvent, String[] eventArgList, boolean isDefault)

protected void renderCancelButton (MarkupOutput out)

Renders the Cancel button for the wait page.
It calls getCancelEvent() to obtain the event for the button
The button is not rendered if:
- getCancelEvent() returns null
- processingButtonsFlags does not have PROCESSING_BUTTONS_CANCEL

Parameters
out output for this transform

protected void renderConstantPromptArea (MarkupOutput out, WebPrompt constPrompt, int ndKey)

This method will render an existing constant prompt in a subexpression that is being edited.

protected void renderDescendantOptions (WebOperatorNode node, Tag tableTag, WebEvent acceptEvent)

protected void renderDottedLine (MarkupOutput out)

Renders a dotted lined to be used as separator between edit forms and filter expression tree

Parameters
out where to write output

protected void renderDownButton (MarkupOutput mainOut, WebNode node)

Throws
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderErrorMessage (MarkupOutput out, String imageTitle, String errorMessage)

protected void renderEventHiddenInputs (MarkupOutput out)

This method will render all of the hidden inputs for the events that will be used within the expression transform.

Parameters
out The MarkupOutput object to render the output to.

protected void renderExpression (MarkupOutput out)

protected void renderFilterNode (MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)

This is the method which renders a single node within the filter. It will recursively call itself and renderOperatorNode to render the whole expression.

Parameters
out The MarkupOutput object to render the output to.
expr The expression being rendered.
node The node currently being rendered.
level The level of the current node.
isReportLimit Whether this expression refers to a report limit expression or the expression that is set on the ExpressionBean. If this is true, then the expression on the ExpressionBean is not the same as the expression being rendered here.

protected void renderJavascript (MarkupOutput out)

This method renders all javascript that will be necessary for the ExpressionGenericTransform to work correctly.

Parameters
out The MarkupOutput object to render the output to.

protected void renderMQConstantTextbox (MarkupOutput out, WebEvent acceptEvent, String constValue, int function)

This method renders the constant textbox for a metric qualification subexpression.

Parameters
out The MarkupOutput object to render the output to.
acceptEvent The event that is used to accept the qualification.
constValue The current constant value.
function The current function being qualified upon.

protected void renderMQEditMode (MarkupOutput out, WebNode node, int level)

This function will render the subexpression for a metric qualfiication which is being edited by the user.

Parameters
out The MarkupOutput object to render the output to.
node The current node being rendered.
level The depth within the filter expression tree of this node.

protected void renderMQFunctions (MarkupOutput out, WebEvent acceptEvent, int function, int functionType, boolean isMetricExprQual, boolean isConstPrompted)

protected void renderMQOperatorOption (MarkupOutput mo, int function, int functionType, int descriptorId, int currentFunction, int currentFunctionType)

protected void renderMQOperatorOption (MarkupOutput mo, int function, int descriptorId, int currentFunction)

protected void renderMQOperatorOptions (MarkupOutput mo, int currentFunction, int currentFunctionType, boolean bUnitComparison)

protected void renderMQUnitComparison (MarkupOutput out, String metricID, WebEvent acceptEvent)

This method will render the unit comparison list for a metric-to-metric qualfication that is currently being edited..

Parameters
out The MarkupOutput object to render the output to.
metricID The metric ID of the currently selected object in the pulldown.
acceptEvent The event that is used to accept the qualificiation.

protected void renderMeNodeEditMode (MarkupOutput out, WebNode node, int level)

This function will render the subexpression for a me node expression which is being edited by the user.

Parameters
out The MarkupOutput object to render the output to.
node The current node being rendered.
level The depth within the filter expression tree of this node.

protected void renderMeNodeQualFunctions (MarkupOutput out, WebEvent acceptEvent, int function, int functionType)

protected void renderMeNodeQualOperatorOptions (MarkupOutput mo, int currentFunction, int currentFunctionType)

protected void renderOperator (MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, boolean isReportLimit, MarkupOutput mainOut, boolean useEditMode)

Throws
IllegalArgumentException
IllegalStateException

protected void renderOperator (MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, int level, boolean isReportLimit)

This method renders the given operator node. It will render the HTML common to all operator nodes being rendered, then delegate to either renderOperatorEditMode or renderOperatorViewMode based upon whether the operator is being edited.

Parameters
out The MarkupOutput object to render the output to.
opNode The operator node being rendered.
leftNode The left child of the operator node.
rightNode The right child of the operator node.
level The depth within the expression tree of the operator node.

protected void renderOperatorEditMode (MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode)

This method renders an operator in edit mode. In this context, an operator refers to an AND/OR/AND NOT/OR NOT node. The edit mode will normally only occur in HTML mode, as those operators are edited via a DHTML menu in DHTML mode.

Parameters
out The MarkupOutput object to render the output to.
opNode The operator node being rendered.
leftNode The left-hand child of the operator node.
rightNode The right-hand child of the operator node.

protected void renderOperatorViewMode (MarkupOutput out, WebOperatorNode opNode, WebNode leftNode, WebNode rightNode, boolean isReportLimit)

This method will render an operator node in view mode. It will render the AND/OR/AND NOT/OR NOT operator node plus any shift buttons.

Parameters
out The MarkupOutput object to render the output to.
opNode The operator node being rendered.
leftNode The left-hand child of the node.
rightNode The right-hand child of the node.
isReportLimit Whether this node comes from a report limit expression. If this is true, then the node does not come from the expression on the ExpressionBean.

protected void renderPromptButton (MarkupOutput out, int promptType, String inputID, boolean isDisabled)

protected void renderPromptButton (MarkupOutput out, int promptType, String inputID, boolean isDisabled, boolean isHidden)

protected void renderRemoveSubexpressionButton (MarkupOutput out, WebNode node, boolean isEditableFilterExpr)

protected void renderSubExpression (MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)

This method renders a subexpression of the expression. It will render a few common GUI elements then delegate to renderSubExpressionEditMode and renderSubExpressionViewMode.

Parameters
out The MarkupOutput object to render the output to.
expr The expression being rendered.
node The node being rendered.
level The level of the node within the expression.
isReportLimit Whether this expression refers to a report limit expression or the expression that is set on the ExpressionBean. If this is true, then the expression on the ExpressionBean is not the same as the expression being rendered here.

protected void renderSubExpressionEditMode (MarkupOutput out, WebNode node, int level)

This function renders a subexpression which is currently being edited by the user. It will generally render the common elements for a subexpression that is being edited then delegate to a type-specific render method.

Parameters
out The MarkupOutput object to render the output to.
node The current node being rendered.
level The depth within the filter expression tree of this node.

protected void renderSubExpressionViewMode (MarkupOutput out, WebExpression expr, WebNode node, int level, boolean isReportLimit)

This is the generic method that renders a non-branch subexpression in view mode. It renders GUI elements such as the delete button and shift buttons, plus the expression itself.

Parameters
out The MarkupOutput object to render the output to.
expr The expression being rendered.
node The currently rendered node.
level The level of the node within the expression.
isReportLimit Whether the expression is from the report limit. If this is true, then the expression passed in will not be the expression set on the ExpressionBean.

protected void renderSubexpressionBodyViewMode (WebExpression expr, WebNode node, int level, boolean isReportLimit, boolean isEditableFilterExpr, MarkupOutput mainOut)

@deprecated

Throws
ClassCastException
UnmodifiableException
IllegalStateException
IllegalArgumentException
ClassCastException
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderSubexpressionBodyViewMode (MarkupOutput mainOut, WebExpression expr, WebNode node, int level, boolean isReportLimit, boolean isEditableFilterExpr)

Throws
ClassCastException
UnmodifiableException
IllegalStateException
IllegalArgumentException
ClassCastException
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderUpAndDownButtons (WebNode node, boolean isEditableFilterExpr, MarkupOutput mainOut)

This method is deprecated.
Replaced by renderUpAndDownButtons(MarkupOutput mainOut, ....)

Throws
UnmodifiableException
IllegalArgumentException
IllegalStateException
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderUpAndDownButtons (MarkupOutput mainOut, WebNode node, boolean isEditableFilterExpr)

Throws
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderUpButton (WebNode node, MarkupOutput mainOut)

This method is deprecated.
Replaced by renderUpButtom(MarkupOutput,....)

Throws
IllegalStateException
IllegalArgumentException
UnmodifiableException
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderUpButton (MarkupOutput mainOut, WebNode node)

Throws
IllegalArgumentException
IllegalStateException
UnmodifiableException

protected void renderXDAMetricSelectorButton (MarkupOutput out)

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.

protected void setFormName (String name)

protected boolean shallRenderAcceptCancell ()

protected boolean shallRenderForm (WebAttributeForm form)

protected boolean shouldShowObject (WebDisplayUnit unit)

Indicate if the unit should be shown. It would be overridden by ThresholdExpressionTransform

Parameters
unit the display unit
Returns
  • boolean, indicate if the unit should be shown.

protected boolean showCloseButton ()

Returns whether to show a close button.

Returns
  • Whether to show a close button.

protected boolean supportsPromptEditor ()

protected boolean useWorkingSetForFormLookup ()