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

Public Attributes

 allowCustomUpdates
 Whether or not to allow custom code to manually create domain objects, add sources, etc,. More...
 
 configurations
 The configurations used by this domain. More...
 
 data
 Wrapper object for all source data locations that should be loaded into this domain. More...
 
 disabled
 If set to 0, no domain is generated for this definition, nor is the contents of. More...
 
 expressions
 Expression elements for use in this domain definition. More...
 
 matching
 Wrapper object for all dictionary data that should be loaded into this domain. More...
 
 metadata
 Metadata info for this domain. More...
 
 metrics
 Metrics for this domain. More...
 
 name
 The name of the domain, which should be unique within the namespace. More...
 
 objectsPackage
 If nonempty, objects will be generated representing the various elements in iKnow indexing. More...
 
 skiplists
 Skiplists for use in this domain. More...
 
 userDictionaries
 User Dictionaries for use in any configuration objects declared in this definition. More...
 
- Public Attributes inherited from nodeWithParameters
 parameters
   More...
 

Private Member Functions

_.Library.Status SaveToClass (_.Library.String pClassName, _.Library.Boolean pOverwriteExisting, _.Library.Boolean pVerbose, _.Library.Boolean pCompile, _.Library.String pSuper)
 Saves this Domain Definition to a class.
 
_.Library.Status ToString (_.Library.String pString, _.Library.Boolean pFormatted)
 Outputs this Domain Definition as a String.
 
_.Library.Status Validate ()
 Validates the domain name and its primary parameters, essential to the creation of the domain. More...
 
_.Library.Status ValidateContent (_.Library.Integer pDomainId)
 Valiates the child elements of this domain, including <list> and its descendants. More...
 
_.Library.Status ValidateStatic (_.Library.Integer pDomainId)
 This method validates all static elements of the domain, such as metadata field definitions,. More...
 

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...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 
- Static Public Attributes inherited from abstractNode
 XMLINCLUDEINGROUP = None
 Do not include this class in the XML groupings.
 
- 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...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

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

Model representation of an iKnow domain object. See also <class>iKnow.Domain</class>

Member Function Documentation

◆ Validate()

_.Library.Status Validate ( )
private

Validates the domain name and its primary parameters, essential to the creation of the domain.

<method>ValidateContent</method> will be called after the domain is instantiated to perform further validation on <domain> contents, being passed the domains ID

◆ ValidateContent()

_.Library.Status ValidateContent ( _.Library.Integer  pDomainId)
private

Valiates the child elements of this domain, including <list> and its descendants.

This method gets passed in the domain ID of the domain being validated, which could be required for some (nested) checks.

◆ ValidateStatic()

_.Library.Status ValidateStatic ( _.Library.Integer  pDomainId)
private

This method validates all static elements of the domain, such as metadata field definitions,.

metrics and any configuration and/or user dictionary objects embedded in this domain definition.

Member Data Documentation

◆ allowCustomUpdates

allowCustomUpdates

Whether or not to allow custom code to manually create domain objects, add sources, etc,.

outside of any updates applied by this Domain Definition itself. If set to false (default), only select operations remain available for custom code, such as setting individual metadata values and building metrics.  

◆ configurations

configurations

The configurations used by this domain.

 

◆ data

Wrapper object for all source data locations that should be loaded into this domain.

 

◆ disabled

disabled

If set to 0, no domain is generated for this definition, nor is the contents of.

this >domain< element validated.  

◆ expressions

expressions

Expression elements for use in this domain definition.

 

◆ matching

Wrapper object for all dictionary data that should be loaded into this domain.

 

◆ metadata

Metadata info for this domain.

 

◆ metrics

Metrics for this domain.

 

◆ name

name

The name of the domain, which should be unique within the namespace.

 

◆ objectsPackage

objectsPackage

If nonempty, objects will be generated representing the various elements in iKnow indexing.

results in the package named in this attribute. Existing objects will be replaced.  

◆ skiplists

skiplists

Skiplists for use in this domain.

 

◆ userDictionaries

userDictionaries

User Dictionaries for use in any configuration objects declared in this definition.