DocBook|Search
Class Reference
%iKnow.UI.MatchingResults
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%iKnow] >  [UI] >  [MatchingResults]
Private  Storage  

class %iKnow.UI.MatchingResults extends %iKnow.UI.AbstractSourceViewer

This is a sample User Interface built on top of the iKnow query APIs, displaying the results of the iKnow Smart Matching API by highlighting matched entities (bold, colored), CRCs (italic) and paths (underlined). Select a source from the dropdown list to see all matched elements in the box below. Clicking any highlighted entity will bring up a detail overview of the matched elements.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 23


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource Loader align aux
backgroundTimerInterval cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
cssLevel dictionaries 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 targets title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%%OIDGet %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 %Extends
%ForceClientRender %GetChildIndex %GetComponent %GetComponentById
%GetComponentByName %GetEventHandlers %GetLinks %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 AddFilter BuildInfoPane
ChangeFilterMDField ChangeFilterMDOp ChangeFilterType ClearFilter
ConvertParameter Decrypt DeleteCurrentVirtualSource DrawColorPicker
DrawElementLiteral DrawElementRole DrawFilter DrawInfo
DrawResult Encrypt EndSession EscapeHTML
EscapeURL ExecuteQuery GetCurrentFilterMode GetCurrentFilterObject
GetCurrentFilterString GetDomain GetInfoPaneText GetNextMatchForEO
GetPage GetSource GetSourceObject GetTerm
GetUrlForDomain HyperEventBody HyperEventCall HyperEventFrame
HyperEventHead Include InitPages InputTerm
InsertHiddenField InsertHiddenFields IsPrivate Link
MakeEntityLink MatchVirtualSource NextPage OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent OnUpdateDomain OnUpdateFilter
OnUpdateSource OnUpdateTerm Page PreviousPage
ProcessInput QuoteJS RemoveFilterAt ResetPages
RewriteURL SelectColor SetBlacklists SetHighlights
ShowError StartTimer StopTimer ThrowError
ToggleGroupLogic UnescapeHTML UnescapeURL UpdateDMO
UpdateDomain UpdateEntOccId UpdateSource UpdateTerm
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addFilterClient
cancelPopup changeFilterMDFieldClient changeFilterMDOpClient changeFilterTypeClient
childrenMutated clearFilterClient clickEntOccClient correctIELayering
createComponent createComponentNS deleteComponent displayInputScreen
displayMatchClient dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler endModal
exposeComponent findElement fireOnLoadEvent fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getProperty
getSettings getType gotoPage inputTermClient
invokeSuper isOfType launchPopupWindow makeId
nextMatch nextPageClient onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onProcessInputClient
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler onTermKeyUp onUpdateFilterClient
onUpdateSourceClient onUpdateTermClient ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler prevMatch previousPageClient realTimeInputClient
refreshContents refreshMDFilterFields removeChild removeFilterClient
render renderContents renderSVG selectColorClient
setBlacklistsClient setComponentId setCurrentGroupClient setHidden
setOverlayMode setProperty setPropertyAll setTraceOption
showBlacklists showFilterForm startModal startProgressBar
stopProgressBar toggleGroupLogicClient updateDomainClient updateFilterClient
updateHighlights updateSourceClient updateTermClient useTermClient


Parameters

• parameter PAGENAME = "iKnow Matching Results";
Optional. This is the display name used for this page. If not provided, the class name is used.

Properties

• property dictionaries as %ZEN.Datatype.string(ZENURL="DICTIONARIES");
• property targets as %ZEN.Datatype.string(ZENURL="TARGETS");

Methods

• method DrawColorPicker(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• method DrawElementLiteral(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• method DrawElementRole(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• method DrawInfo(seed As %ZEN.Datatype.string) as %Status
• method DrawResult(seed As %ZEN.Datatype.string) as %Status
• method GetInfoPaneText() as %String
Returns the text to be displayed in infoPane. To be overridden by the subclass using it.
• method GetNextMatchForEO(forward As %String) as %Integer [ ZenMethod ]
• classmethod MakeEntityLink(entity As %String) as %String
• method MatchVirtualSource() as %Status [ ZenMethod ]
• method OnUpdateDomain(domainId As %Integer) as %Status
This method can be overridden at the subclass level to take any additional server-side actions when the domain is changed.
• method OnUpdateSource(sourceId As %Integer) as %Status
Server-side method subclasses can override to take additional actions upon a change in the current source.
• method SelectColor(pDictId As %Integer, pColor As %String) as %Status [ ZenMethod ]
• method SetHighlights(pDictionaries, pTargets) as %Status [ ZenMethod ]
• method UpdateDMO(dmoId As %Integer) as %Status [ ZenMethod ]
• method UpdateEntOccId(entOccId As %Integer) as %Status [ ZenMethod ]
• method clickEntOccClient(entOccId) [ Language = javascript ]
• method displayMatchClient(dmo) [ Language = javascript ]
• method nextMatch() [ Language = javascript ]
• method onProcessInputClient() [ Language = javascript ]
• method onUpdateSourceClient() [ Language = javascript ]
Client-side method subclasses can override to take additional actions upon a change in the current source.
• method prevMatch() [ Language = javascript ]
• method selectColorClient(pDictId, pColor) [ Language = javascript ]
• method updateHighlights() [ Language = javascript ]