Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [PMML] >  [Definition]
Private  Storage   

abstract class %DeepSee.PMML.Definition extends %ZEN.Component.page

This class represents a predictive model described in PMML (Predictive Modelling Markup Language), an XML standard managed by the Data Mining Group (www.dmg.org) for describing Predictive Analytics models.

Subclasses of this class should provide this XML in an XData block named PMML, so it will be validated and interpreted upon compiling the class. Upon compilation, additional helper classes will be automatically generated:

In addition to the generated classes, subclasses of this class are also available as Zen pages so the models they define can be run from a User Interface.

Use this class' %GetModelClassName to retrieve the model class for a named model in the PMML definition and then invoke its %Execute* methods as desired. See also the %DeepSee.PMML.Model.AbstractModel class reference for more information about these execution options, or %DeepSee.PMML.Utils for executing the model against a batch of records at once.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 19


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
disabled dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle id index
label labelClass labelDisabledClass labelPosition
labelStyle layout name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
parent showLabel slice title
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 %GetDataClassName %GetEventHandlers %GetLinks
%GetModelClassName %GetModelInstance %GetPageName %GetParameter
%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 %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnPreHTTP %OnSubmit %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion ConvertParameter Decrypt Encrypt
EscapeHTML EscapeURL HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore cancelPopup childrenMutated correctIELayering
createComponent createComponentNS deleteComponent disableUnusedFields
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getProperty getSettings getType
gotoPage invokeSuper isOfType launchPopupWindow
makeId onChangeModel onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents removeChild render
renderContents renderSVG reset setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption startModal startProgressBar stopProgressBar
update


Parameters

• parameter DOMAIN = "PMML";
Localization domain

Methods

• classmethod %GetDataClassName() as %String
Returns the name of the %DeepSee.PMML.Data class generated upon compiling this PMML definiton.
• classmethod %GetModelClassName(ByRef pModelName As %String = "") as %String
Returns the class name of the model identified by pModelName in PMML. If left blank, returns the class name of the first model in the model definition, setting pModelName to its logical name at the same time.
• classmethod %GetModelInstance(ByRef pModelName As %String = "", ByRef pModel As %DeepSee.PMML.Model.AbstractModel) as %Status
This method returns a %DeepSee.PMML.Model.AbstractModel instance for the model in this definition corresponding to pModelName.
• method %OnAfterCreatePage() as %Status
Populates the properties and models on this Zen page according to the contents of PMML
• method disableUnusedFields() [ Language = javascript ]
• method onChangeModel(model) [ Language = javascript ]
Invoked when selecting a model in the GUI
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method reset() [ Language = javascript ]
• method update(id, value) [ Language = javascript ]
Update test page contents based on user input


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