This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%DeepSee.UI.Dialog.AdvancedFilter

class %DeepSee.UI.Dialog.AdvancedFilter extends %DeepSee.UI.Dialog.standardDialog

This dialog lets the user create or edit an Advanced filter definition for a DeepSee pivot.
This can also be used to create or edit a Named Filter for a DeepSee Subject Area.

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 1;
Inherited description: If true, then this dialog displays an Apply button.

Properties

property cubeName as %ZEN.Datatype.string (ZENURL = "CUBE");
Cube name.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
property expression as %ZEN.Datatype.string (ZENURL = "EXPRESSION");
Initial filter expression.
Property methods: expressionDisplayToLogical(), expressionGet(), expressionIsValid(), expressionLogicalToDisplay(), expressionLogicalToOdbc(), expressionNormalize(), expressionSet()
property filterMsrTypes as %ZEN.Datatype.string;
List of possible filter (cube element) subtypes (measures only)
Property methods: filterMsrTypesDisplayToLogical(), filterMsrTypesGet(), filterMsrTypesIsValid(), filterMsrTypesLogicalToDisplay(), filterMsrTypesLogicalToOdbc(), filterMsrTypesNormalize(), filterMsrTypesSet()
property filterName as %ZEN.Datatype.string (ZENURL = "FILTERNAME");
For named filters, this is the filter name.
Property methods: filterNameDisplayToLogical(), filterNameGet(), filterNameIsValid(), filterNameLogicalToDisplay(), filterNameLogicalToOdbc(), filterNameNormalize(), filterNameSet(), filterNamesDisplayToLogical(), filterNamesGet(), filterNamesIsValid(), filterNamesLogicalToDisplay(), filterNamesLogicalToOdbc(), filterNamesNormalize(), filterNamesSet()
property filterNames as %ZEN.Datatype.string;
List of possible filter (cube element) names (captions).
Property methods: filterNamesDisplayToLogical(), filterNamesGet(), filterNamesIsValid(), filterNamesLogicalToDisplay(), filterNamesLogicalToOdbc(), filterNamesNormalize(), filterNamesSet()
property filterTypes as %ZEN.Datatype.string;
List of possible filter (cube element) types.
Property methods: filterTypesDisplayToLogical(), filterTypesGet(), filterTypesIsValid(), filterTypesLogicalToDisplay(), filterTypesLogicalToOdbc(), filterTypesNormalize(), filterTypesSet()
property filterValues as %ZEN.Datatype.string;
List of possible filter (cube element) values.
Property methods: filterValuesDisplayToLogical(), filterValuesGet(), filterValuesIsValid(), filterValuesLogicalToDisplay(), filterValuesLogicalToOdbc(), filterValuesNormalize(), filterValuesSet()
property isNamedFilter as %ZEN.Datatype.boolean (ZENURL = "NAMEDFILTER");
If true, this is a Named Filter
Property methods: isNamedFilterDisplayToLogical(), isNamedFilterGet(), isNamedFilterIsValid(), isNamedFilterLogicalToDisplay(), isNamedFilterLogicalToOdbc(), isNamedFilterLogicalToXSD(), isNamedFilterNormalize(), isNamedFilterSet(), isNamedFilterXSDToLogical()
property searchKey as %ZEN.Datatype.string;
Current search Key
Property methods: searchKeyDisplayToLogical(), searchKeyGet(), searchKeyIsValid(), searchKeyLogicalToDisplay(), searchKeyLogicalToOdbc(), searchKeyNormalize(), searchKeySet()
property selectedIndex as %ZEN.Datatype.integer;
Index of current item.
Property methods: selectedIndexDisplayToLogical(), selectedIndexGet(), selectedIndexIsValid(), selectedIndexLogicalToDisplay(), selectedIndexLogicalToOdbc(), selectedIndexNormalize(), selectedIndexSet()

Methods

method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
method BuildFilterGraph(ByRef pParameters, Output pMetaData, Output pData) as %Status
Return the initial filter graph for a given cube and MDX expression.
pParameters("cube") = cube name
pParameters("expression") = MDX expression
method GetFiltersBySearchKey() as %Status [ ZenMethod ]
This method recalculates the available filters in this cube, taking into account a search key.
method GetMemberList(ByRef pParameters, Output pMetaData, Output pData) as %Status
Return the list of members for a given cube and dimension.
pParameters("cube") = cube name
pParameters("dimension") = cube element
pParameters("search") = search key
classmethod SaveNamedFilter(pCube As %String, pFilterName As %String, pTooltip As %String, pSpec As %String) as %String [ ZenMethod ]
Save a named filter.
clientmethod addBranch() [ Language = javascript ]
Add a new branch.
clientmethod addCondition() [ Language = javascript ]
Add a new condition.
clientmethod addUndoAction() [ Language = javascript ]
Remember the current state in the undo buffer.
clientmethod adjustSize() [ Language = javascript ]
Adjust sizes components on the page.
clientmethod applyLiteral() [ Language = javascript ]
Change of literal value.
clientmethod buildNodeIndex(node, parent) [ Language = javascript ]
Build index of nodes Set _index and _parent as side effect.
clientmethod canUndo() [ Language = javascript ]
Return true if it is possible to undo an action
clientmethod changeKey(idx) [ Language = javascript ]
Change of key type.
clientmethod changeMember(idx, ctrl) [ Language = javascript ]
The user has selected a new item in the *member* select list.
clientmethod changeNode(idx, type, value, text) [ Language = javascript ]
Change of node type.
clientmethod changeSearchKey() [ Language = javascript ]
Change of search key.
clientmethod clearNodes(render) [ Language = javascript ]
Reset the expression graph.
clientmethod clearUndoBuffer() [ Language = javascript ]
clientmethod cloneObject(obj, clone) [ Language = javascript ]
Create a clone of the given object.
clientmethod convertNodeToMDX(node) [ Language = javascript ]
Convert the expression to an MDX clause. Return an object containing: {text, hasSet, levelName}
clientmethod convertToMDX() [ Language = javascript ]
Convert the expression graph to an MDX clause.
This is used to convert the current graphical expression into the MDX that will be used as a %FILTER clause.
clientmethod getDialogValue() [ Language = javascript ]
Get return value for dialog.
clientmethod getFilterGraph() [ Language = javascript ]
Return the object graph that describes the filter.
clientmethod keyToMDX(key) [ Language = javascript ]
Convert a key value to MDX.
clientmethod ondialogFinish(action) [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod removeCondition() [ Language = javascript ]
Remove the current condition.
clientmethod renderCommands() [ Language = javascript ]
Update the command panel.
clientmethod renderHelp() [ Language = javascript ]
Update the help box.
clientmethod renderMeasureOperatorNode(node) [ Language = javascript ]
Get HTML for a measure operator node within the expression graph;
clientmethod renderNode(node, level) [ Language = javascript ]
Get HTML for a node within the expression graph.
clientmethod renderOperatorNode(node) [ Language = javascript ]
Get HTML for an operator node within the expression graph;
clientmethod renderOperatorSelector(node) [ Language = javascript ]
Get HTML for an operator selector the expression graph;
clientmethod renderTree() [ Language = javascript ]
Update the expression tree.
clientmethod renderValueNode(node) [ Language = javascript ]
Get HTML for a value selector the expression graph;
clientmethod selectItem(idx) [ Language = javascript ]
Mouse click on item in diagram.
clientmethod undo() [ Language = javascript ]
Undo the most recent change.
clientmethod updateSearchBoxControls() [ Language = javascript ]
Update controls to match current state.

Inherited Members

Inherited Properties

Inherited Methods

Feedback