DomainDefinition Class Reference

Inheritance diagram for DomainDefinition:

Collaboration diagram for DomainDefinition:

Static Private Member Functions
_.Library.Status	Build (_.Library.Boolean pVerbose, pParams, _.Library.Boolean pAsync)
_.Library.Status	DropData (_.Library.Boolean pDropDictionaries, _.Library.Boolean pDropSkipLists)
	Drops all non-static data from the domain defined by this class. More...
_.Library.Integer	GetDomainId ()
	Returns the domain ID corresponding to the domain defined in <xdata>Domain</xdata>
_.Library.String	GetDomainName ()
	Returns the domain name as defined in <xdata>Domain</xdata>
_.Library.Status	GetExpressionValue (_.Library.String pName, _.Library.String pValue, pParams)
	Evaluates the expression named pName and returns the result by reference.
_.Library.Status	OnAfterBuild (_.Library.Integer pDomainId)
_.Library.Status	OnAfterDropData (_.Library.Integer pDomainId, _.Library.Boolean pDropDictionaries, _.Library.Boolean pDropSkipLists)
_.Library.Status	OnBeforeBuild (_.Library.Integer pDomainId)
_.Library.Status	OnBeforeDropData (_.Library.Integer pDomainId, _.Library.Boolean pDropDictionaries, _.Library.Boolean pDropSkipLists)
_.Library.Status	UpdateDictionaries (_.Library.Boolean pDropFirst, _.Library.Boolean pMatch, _.Library.Boolean pVerbose, pParams, _.Library.Boolean pAsync)
_.Library.Status	UpdateMetrics (_.Library.Boolean pDropFirst, _.Library.Boolean pVerbose)

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

The InterSystems IRIS NLP iKnow technology is now deprecated. Please see the product documentation for more detail.

For details on using this class, see NLP Domains.

Subclasses of this class declaratively define an iKnow domain and its contents using an XML representation in the <xdata>Domain</xdata> XData block. Compiling this class will automatically create the iKnow domain and any static elements or settings within, such as metadata fields, domain parameters and metrics. Using <method>Build</method>) users can then "build" the contents of the domain, loading any sources from the locations referred to in <xdata>Domain</xdata> and populating relevant metadata, matching and metrics.

For a detailed reference of the available elements and attributes of this XData block, consult the class reference for <class>iKnow.Model.domain</class> and other classes in the <package>iKnow.Model</package> package.

Member Function Documentation

Build()

_.Library.Status Build ( _.Library.Boolean  pVerbose,   pParams, _.Library.Boolean  pAsync  )

staticprivate

Invoking this method will build the domain described in <xdata>Domain</xdata>,

which includes loading data and dictionaries, matching dictionaries and building metrics, depending on the various settings of the <domain> element and its sub-elements.

The pVerbose argument controls whether status output is provided to stdev (if pAsync=0) or written to a global for GUI pickup (pAsync=1, for internal use only).

DropData()

_.Library.Status DropData ( _.Library.Boolean  pDropDictionaries, _.Library.Boolean  pDropSkipLists  )

staticprivate

Drops all non-static data from the domain defined by this class.

Depending on the values of pDropDictionaries and pDropSkipLists, dictionary info and Skiplists are purged as well.

OnAfterBuild()

_.Library.Status OnAfterBuild ( _.Library.Integer  pDomainId )

staticprivate

Callback invoked at the end of <method>Build</method>. Subclasses can implement this

method to execute custom code at the end of a domain build operation.

OnAfterDropData()

_.Library.Status OnAfterDropData ( _.Library.Integer  pDomainId, _.Library.Boolean  pDropDictionaries, _.Library.Boolean  pDropSkipLists  )

staticprivate

Callback invoked at the end of <method>DropData</method>. Subclasses can implement this

method to execute custom code at the end of a drop data operation.

OnBeforeBuild()

_.Library.Status OnBeforeBuild ( _.Library.Integer  pDomainId )

staticprivate

Callback invoked at the start of <method>Build</method>. Subclasses can implement this

method to execute custom code at the start of a domain build operation.

OnBeforeDropData()

_.Library.Status OnBeforeDropData ( _.Library.Integer  pDomainId, _.Library.Boolean  pDropDictionaries, _.Library.Boolean  pDropSkipLists  )

staticprivate

Callback invoked at the start of <method>DropData</method>. Subclasses can implement this

method to execute custom code at the start of a drop data operation.

UpdateDictionaries()

_.Library.Status UpdateDictionaries ( _.Library.Boolean  pDropFirst, _.Library.Boolean  pMatch, _.Library.Boolean  pVerbose,   pParams, _.Library.Boolean  pAsync  )

staticprivate

This method will update dictionaries based on the current contents of the <matching>

element in <xdata>Domain</xdata>, without making any changes to the current data (in terms of sources) already stored in the domain. If pMatch is 1, all sources in the domain will be matched after the dictionaries are updated. If pDropFirst is 1, the current dictionaries will first be dropped from the domain, otherwise only new dictionary entries will be added (no updates or deletions of existing entries).

Build parameters passed through pParams will be used to override default expression values used in the dictionary definitions in the same way as in <method>Build</method>.

The pVerbose argument controls whether status output is provided to stdev (if pAsync=0) or written to a global for GUI pickup (pAsync=1, for internal use only).

UpdateMetrics()

_.Library.Status UpdateMetrics ( _.Library.Boolean  pDropFirst, _.Library.Boolean  pVerbose  )

staticprivate

This method will explicitly rebuild all metrics in the domain described in <xdata>Domain</xdata>,

optionally dropping any existing values first if pDropFirst is 1.

See also the BuildAll() method in <class>iKnow.Metrics.MetricBuilder</class>.