Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%iKnow] >  [Classification] >  [UI] >  [ClassifierBuilder]
Private  Storage   

deprecatedclass %iKnow.Classification.UI.ClassifierBuilder extends %DeepSee.UI.standardPage

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 8 93


Summary

This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource StdTitle aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode definitionClass disabled
docbookId domain dragAndDrop dragEnabled
dropEnabled enableAutoRefresh enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hideAdvanced hint hintClass
hintStyle homePage id index
label labelClass labelDisabledClass labelPosition
labelStyle layout limitPopups metaData
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate optimizerTask pageModified
parent pmml searchKey showLabel
slice title trainingSet tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod
%EndScript %Eval %EvalC %Extends
%ForceClientRender %GetChildIndex %GetComponent %GetComponentById
%GetComponentByName %GetEventHandlers %GetLinks %GetLocatorLinks
%GetPageName %GetParameter %GetRootLink %GetValueById
%GetValueByName %GetXMLName %IsA %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %ShowBackgroundTaskOutput %StartScript
%ValidateObject %ZENVersion BuildMenu CheckContextLinks
CheckEnterpriseManager ConvertParameter Decrypt DeleteClassifier
DoLogout DrawCheckbox DrawLocator DrawOptimizerTerms
DrawRibbon DrawSelectAllNone DrawTitle Encrypt
EscapeHTML EscapeURL ExecuteResultSet Export
GenerateRuleSet GetCSPURL GetContextLinks GetDocURL
GetNewURL GetQuickLinks HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link LoadDataSourceFields OnChangeDomain
OnChangeFilter OnDrawRibbon OnGetClassifierObject OnGetRibbonInfo
OnGetTree OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Optimize OptimizeLoadTerms Page PopulateTerms
QuoteJS RewriteURL SetClassname ShowError
StartTimer StopTimer SubmitClassifier ThrowError
UnescapeHTML UnescapeURL UpdateSQL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType add
addChild addChildAfter addChildBefore addElements
cancelPopup changeDomain changeFilter changeFilterOperator
changePassword childrenMutated clickTreeNode cmdBuild
cmdDelete cmdEditDataSource cmdExport cmdNew
cmdOpen cmdOptimize cmdSave cmdTest
confirmLeave correctIELayering createClassifier createComponent
createComponentNS deleteComponent disableCommandButton dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dragTreeNode
drawConnector dropHandler dropRule dropStartHandler
editFallback editPredicate editPredicateAdd editPredicateDrop
editRule editTerm enableCommandButton endModal
explore exploreDelayed exploreNext exploreSQL
exploreTop exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction generateRuleNodes
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageMeta getPageTitle getPredicateForId getProperty
getSettings getStringForTerm getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
hideCommandButton invokeSuper isOfType launchPopupWindow
logout makeId navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refresh refreshButtons
refreshContents reloadPage removeChild removeTerm
render renderContents renderRule renderSVG
saveAs searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress selectAllTerms selectNoTerms
selectPredicateType setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showEditPredicate showEditRule showEditTerm
showHelp startModal startOptimizer startProgressBar
stopProgressBar switchNamespace toggleAdvancedMode toggleElement
updateBackgroundInfo updateClassifier updateMethod updateModelProp


Parameters

• parameter DOMAIN = "%iKnow";
Set this to the correct domain.
• parameter PAGENAME = "Text Classifier Builder";
Name of this page.
• parameter RESOURCE = "%Development";
All Analytics pages require %DeepSee_Portal USE.

Properties

• property definitionClass as %ZEN.Datatype.string(ZENURL="CLASS");
• property domain as %ZEN.Datatype.integer;
• property hideAdvanced as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
• property optimizerTask as %ZEN.Datatype.integer [ InitialExpression = 1 ];
• property pmml as %ZEN.Datatype.string(MAXLEN="");
• property trainingSet as %ZEN.Datatype.string;

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Builds breadcrumb links
• method %OnAfterCreatePage() as %Status
Decorate the page.
• classmethod %OnFinishBackgroundTask(pTaskID As %String)
This server-side callback method is called whenever the client calls to monitor the current background task and the task is complete. Typically a subclass uses this to send back JavaScript to update the page.
• method %OnGetPageName() as %String
Returned value is used as leaf of breadcrumb
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• classmethod %OnMonitorBackgroundTask(pTaskID As %String, pStatus As %String, pPercentComplete As %Float)
This server-side callback method is called whenever the client calls to monitor the current background task. Typically a subclass uses this to send back JavaScript to update a progress bar.
• classmethod %ShowBackgroundTaskOutput(pTaskID As %String)
• method DeleteClassifier() as %Status [ ZenMethod ]
• method DrawCheckbox(pSeed As %String) as %Status
• method DrawOptimizerTerms(pSeed As %String) as %Status
• method DrawSelectAllNone(pSeed As %String) as %Status
• method ExecuteResultSet(pRS As %Library.ResultSet, ByRef tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
ExecuteResult
• method Export(pClassname As %String, pOverwrite As %Boolean) as %Status [ ZenMethod ]
• method GenerateRuleSet() as %Status [ ZenMethod ]
GenerateRule
• method LoadDataSourceFields() as %Status [ ZenMethod ]
• method OnChangeDomain(pDomainId As %Integer) as %Status [ ZenMethod ]
called when selNewDomain changes
• method OnChangeFilter(pDomainId As %Integer, pField As %String, pSuffix As %String) as %Status [ ZenMethod ]
• method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content is best wrapped within a single td element. It can also consist of multiple td elements.

To achieve a fixed position for elements within the ribbon, for a fixed width page you can use a single enclosing td that contains a table and a single tr, with td elements inside that single tr that contain your content for the ribbon.

To achieve a fixed position for elements within the ribbon, for a page whose width varies depending on its contents (thereby stretching the ribbon) you can use multiple td elements to contain your content and then a final td element that is empty and has width 40% (or so) to push your contents towards the left and keep them in their proper locations.

• method OnGetClassifierObject(ByRef Params, Output pObject As %RegisteredObject) as %Status
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
This callback, if implemented returns information used to display the standard ribbon bar.
pDisplay is true if the ribbon should be displayed.
pViewIcons is an array describing "view" buttons to display: pViewIcons(n) = $LB(id,help,icon)
pSortOptions is an array describing "sort" options to display: pSortOptions(n) = $LB(id,caption,help)
pSearch is true if a search box is displayed.
pRibbonTitle is a title to display.
pCommands is an array of command buttons to display: pCommands(n) = $LB(id,caption,help,onclick)
• method OnGetTree(pRoot As %String, Output pTree, ByRef pParms) as %Status
• method Optimize(pMetric As %String, pSteps As %Integer, pRemoveRatio As %Double) as %Status [ ZenMethod ]
• method OptimizeLoadTerms(pMode As %String, pSpec As %String) as %Status [ ZenMethod ]
• method PopulateTerms(pMetric As %String, pCount As %Integer) as %Status [ ZenMethod ]
• method SetClassname(pClassname As %String) as %String [ ZenMethod ]
• method SubmitClassifier(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, Output pResponseObject As %RegisteredObject) as %Status
• method UpdateSQL(pSQL As %String) as %String [ ZenMethod ]
• method add(string, type, individual) [ Language = javascript ]
• method addElements(id, type, individual) [ Language = javascript ]
• method changeDomain(domain) [ Language = javascript ]
• method changeFilter(domain, field, suffix) [ Language = javascript ]
• method changeFilterOperator(operator) [ Language = javascript ]
• method clickTreeNode(tree) [ Language = javascript ]
• method cmdBuild() [ Language = javascript ]
• method cmdDelete() [ Language = javascript ]
• method cmdEditDataSource() [ Language = javascript ]
• method cmdExport() [ Language = javascript ]
• method cmdNew() [ Language = javascript ]
• method cmdOpen() [ Language = javascript ]
• method cmdOptimize() [ Language = javascript ]
• method cmdSave() [ Language = javascript ]
• method cmdTest() [ Language = javascript ]
• method confirmLeave() [ Language = javascript ]
• method createClassifier() [ Language = javascript ]
called when btnNewCreate is clicked
• method dragTreeNode(tree, dragData) [ Language = javascript ]
• method drawConnector(svg, fromNode, toNode) [ Language = javascript ]
• method dropRule(ruleIndex) [ Language = javascript ]
• method editFallback(ruleIndex) [ Language = javascript ]
• method editPredicate(end) [ Language = javascript ]
• method editPredicateAdd() [ Language = javascript ]
• method editPredicateDrop() [ Language = javascript ]
• method editRule(category, score=1, fallback=0) [ Language = javascript ]
• method editTerm() [ Language = javascript ]
• method explore(id, string) [ Language = javascript ]
• method exploreDelayed(id, string) [ Language = javascript ]
• method exploreNext(id, shift) [ Language = javascript ]
• method exploreSQL(sql) [ Language = javascript ]
• method exploreTop(metric) [ Language = javascript ]
• method generateRuleNodes(svg, pred, level, x, predicateId) [ Language = javascript ]
• method getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row. This should be implemented in a subclass.
• method getPredicateForId(model, predId) [ Language = javascript ]
• method getStringForTerm(model, termIndex) [ Language = javascript ]
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onunloadHandler() [ Language = javascript ]
Check if user really wants to exit if they have not saved changes
• method refresh() [ Language = javascript ]
• method refreshButtons() [ Language = javascript ]
• method removeTerm(termPos) [ Language = javascript ]
• method renderRule(ruleIndex) [ Language = javascript ]
• method saveAs(classname) [ Language = javascript ]
• method selectAllTerms(type) [ Language = javascript ]
• method selectNoTerms(type) [ Language = javascript ]
• method selectPredicateType(predicate, type) [ Language = javascript ]
• method showEditPredicate(predId, show) [ Language = javascript ]
• method showEditRule(ruleIndex) [ Language = javascript ]
• method showEditTerm() [ Language = javascript ]
• method startOptimizer() [ Language = javascript ]
• method toggleAdvancedMode(hide) [ Language = javascript ]
• method toggleElement(id, value) [ Language = javascript ]
• method updateBackgroundInfo(label, show) [ Language = javascript ]
• method updateClassifier() [ Language = javascript ]
• method updateMethod(method) [ Language = javascript ]
• method updateModelProp(prop, value) [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.