IRISLIB database
IndexingResults Class Reference
Inheritance diagram for IndexingResults:
Collaboration diagram for IndexingResults:

Public Member Functions

_.Library.String GetInfoPaneText ()
 Returns the text to be displayed in <xdata>infoPane</xdata>. More...
 
_.Library.Status OnChangeLanguageMode ()
 This method is called whenever the language mode changes, as part of <method>UpdateSource</method> More...
 
_.Library.Status OnUpdateDomain (_.Library.Integer domainId)
 This method can be overridden at the subclass level to take any additional server-side. More...
 
_.Library.Status OnUpdateSource (_.Library.Integer sourceId)
 Server-side method subclasses can override to take additional actions upon a change in the. More...
 
 onUpdateSourceClient (source)
 Client-side method subclasses can override to take additional actions upon a change in the. More...
 
- Public Member Functions inherited from AbstractPortal
_.Library.Status BuildInfoPane ()
 Builds <xdata>infoPane</xdata>.
 
_.Library.Status DrawFilter (_.Library.String pSeed)
 This method draws the filter in the filter popup screen.
 
_.Library.Status EndSession ()
 Utility method to end the session from the client.
 
_.Library.Boolean ExecuteQuery (_.Library.ResultSet pRS, _.Library.Status tSC, _.ZEN.Auxiliary.QueryInfo pInfo)
 Utility method to avoid executing queries when no domain is specified (which could lead to. More...
 
_.Library.Boolean ExecuteQuerySys (_.Library.ResultSet pRS, _.Library.Status tSC, _.ZEN.Auxiliary.QueryInfo pInfo)
 Same as ExecuteQuery, but will use the system domain (ID=0) if ..source<0.
 
_.Library.Integer GetCurrentFilterMode ()
 Returns the current filter mode, if any.
 
_.iKnow.Filters.Filter GetCurrentFilterObject ()
 Returns the current filter object, if any.
 
_.Library.String GetCurrentFilterString ()
 Returns the current filter string, if any. More...
 
_.Library.Integer GetPage (_.Library.String componentName)
 Utility method to return the "current page" stored in the session for the supplied component. More...
 
_.Library.Integer GetSource ()
 Returns the currently selected source ID. More...
 
_.iKnow.Objects.Source GetSourceObject ()
 Returns the currently selected source as a <class>iKnow.Objects.Source</class> or. More...
 
_.Library.Status InitPages ()
 This method should to be implemented by subclasses using the paging functions, giving all paged. More...
 
_.Library.Integer NextPage (_.Library.String componentName)
 Updates the current page for the supplied component to the next integer value.
 
_.Library.Status OnUpdateTerm (_.Library.String term)
 Server-side methods subclasses can override to take additional actions when the user selects. More...
 
_.Library.Integer PreviousPage (_.Library.String componentName)
 Updates the current page for the supplied component to the previous integer value (minimum value is 1).
 
_.Library.Integer ResetPages ()
 Resets all page information in the session.
 
_.Library.Status UpdateDomain (_.Library.Integer domainId)
 ZenMethod to take appropriate cleanup action if the domain is updated. More...
 
_.Library.Status UpdateSource (_.Library.Integer sourceId)
 Server-side method updating the source pointers and taking any other appropriate actions. More...
 
_.Library.Status UpdateTerm (_.Library.String term)
 ZenMethod taking appropriate server-side cleanup and update actions when a new term is selected. More...
 
 drillFilterClient (filterString)
 Client-side method called when the "drill" link next to a filter (in VIEW mode) is clicked.
 
_.Library.Status nextPageClient (componentName)
 Client-side method to trigger a components query to be re-executed for the next page of results.
 
 onTermKeyUp ()
 Key capture method to trigger <method>updateTermClient</method> when the enter key is pressed.
 
 onUpdateFilterClient ()
 Client-side method subclasses can override to execute additional logic when the user has changed. More...
 
 onUpdateTermClient (term)
 Client-side method subclasses can override to take additional actions when the user selects. More...
 
_.Library.Status previousPageClient (componentName)
 Client-side method to trigger a components query to be re-executed for the previous page of results.
 
 showFilterForm ()
 Display the filter popup window.
 
 updateFilterClient ()
 Client-side method called when the user commits his filter criteria in the filter popup window. More...
 
 updateSourceClient (source)
 Client-side method updating the source pointers and taking any other appropriate actions. More...
 
 updateTermClient (term)
 Client-side method to be called when the user selects a new term, which will call. More...
 
 useTermClient (term)
 Client-side method which will explicitly select a certain term, updating the txtTerm input field in. More...
 

Public Attributes

 hlMode
   More...
 
 showStems
   More...
 
 sortCriteria
   More...
 
- Public Attributes inherited from AbstractSourceViewer
 Loader
   More...
 
- Public Attributes inherited from AbstractPortal
 domain
   More...
 
 filter
   More...
 
 filtermode
   More...
 
 languageMode
   More...
 
 skiplists
   More...
 
 source
   More...
 
 term
   More...
 

Additional Inherited Members

- Static Public Attributes inherited from AbstractPortal
 AUTONS = None
 If true, auto-switch namespace to whatever $NAMESPACE is passed in.
 
 RESOURCE = None
 All pages in <package>iKnow.UI</package> require at least the Development resource.
 

Detailed Description

This is a sample User Interface built on top of the iKnow APIs, visualizing the results of the iKnow Smart Indexing API. You can either select an existing source from the dropdown list, or use the input button to enter free text directly.

Member Function Documentation

◆ GetInfoPaneText()

_.Library.String GetInfoPaneText ( )

Returns the text to be displayed in <xdata>infoPane</xdata>.

To be overridden by the subclass using it.

Reimplemented from AbstractPortal.

◆ OnChangeLanguageMode()

_.Library.Status OnChangeLanguageMode ( )

This method is called whenever the language mode changes, as part of <method>UpdateSource</method>

or <method>OnAfterCreatePage</method>

Reimplemented from AbstractPortal.

◆ OnUpdateDomain()

_.Library.Status OnUpdateDomain ( _.Library.Integer  domainId)

This method can be overridden at the subclass level to take any additional server-side.

actions when the domain is changed.

Reimplemented from AbstractPortal.

◆ OnUpdateSource()

_.Library.Status OnUpdateSource ( _.Library.Integer  sourceId)

Server-side method subclasses can override to take additional actions upon a change in the.

current source.

Reimplemented from AbstractPortal.

◆ onUpdateSourceClient()

onUpdateSourceClient (   source)

Client-side method subclasses can override to take additional actions upon a change in the.

current source.

Reimplemented from AbstractPortal.

Member Data Documentation

◆ hlMode

hlMode

 

 

◆ showStems

showStems

 

 

◆ sortCriteria

sortCriteria