Inheritance diagram for Domain:

[legend]

Collaboration diagram for Domain:

[legend]

Public Member Functions
_.Library.Status	OnNew (_.Library.String pName, _.Library.String pBuildFlags)
	Instantiates a new Domain object iwth the given domain name. More...

_.Library.Status	DropData (_.Library.Boolean dropMetadataDefinitions, _.Library.Boolean dropDictionaries, _.Library.Boolean dropTempGlobals, _.Library.Boolean dropSkipLists, _.Library.Boolean dropMetricDefinitions)
	This method will drop all sources and subsequent indexes from this domain. More...

_.Library.String	GetParameter (_.Library.String paramName, _.Library.String definedAt)
	Returns the value used for parameter paramName for this domain. More...

_.Library.Status	GetParameters (pParams)

_.Library.Boolean	IsEmpty ()
	Returns whether or not a domain is empty. More...

_.Library.Status	SetParameter (_.Library.String paramName, _.Library.String paramValue)
	Sets a domain-specific parameter, overriding the system default.

_.Library.Status	UnsetParameter (_.Library.String paramName)
	Unsets a domain-specific parameter, so it will use the system default again.

Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

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 Member Functions
_.iKnow.Domain	Create (_.Library.String name, _.Library.Integer sortField, _.Library.Status sc, _.Library.String buildFlags)
	Creates a domain with the specified domain name in the given namespace. More...

_.Library.Status	Delete (_.Library.String domainName)
	Utility method to delete a domain from the system, including its data, settings. More...

_.Library.Status	DeleteId (_.Library.Integer domainId)
	Utility method to delete a domain from the system, including its data, settings. More...

_.Library.Boolean	Exists (_.Library.String name)
	Checks whether a domain with the given name already exists within the namespace. More...

_.Library.String	GetCurrentSystemVersion ()

_.Library.Integer	GetOrCreateId (_.Library.String name, _.Library.Integer sortField, _.Library.Status sc)

_.Library.String	GetSystemParameter (_.Library.String paramName)
	Returns the current namespace-wide value for a domain parameter if there is one registered. More...

_.iKnow.Domain	Open (_.Library.String name, _.Library.Status sc)
	Opens a domain object with the specified name. More...

_.iKnow.Domain	OpenId (_.Library.Integer id, _.Library.Status sc)
	Opens a domain object with the specified ID. More...

_.Library.Status	RegisterImportedDomain (_.Library.Integer domainId)
	This method has been deprecated. More...

_.Library.Status	Rename (_.Library.String pFrom, _.Library.String pTo)
	This method renames an existing domain named pFrom to pTo,. More...

_.Library.Status	SetSystemParameter (_.Library.String paramName, _.Library.String paramValue)
	Registers a domain parameter at the namespace level, for all domains in the current namespace. More...

_.Library.Status	UnsetSystemParameter (_.Library.String paramName)
	Removes a namespace-level default parameter value for the given parameter name.

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Public Attributes
	DefinitionClass
	The name of the Domain Definition class managing this domain, if any. More...

	Id
	The automatically generated ID for this domain, which is unique across namespaces. More...

	Name
	The name of this domain, which should be unique within the namespace (case-insensitive) More...

	Version
	Stores the iKnow data structure version number for this domain. More...

Private Member Functions
	DispatchGetProperty (_.Library.String Property)
	Is used to get the value of an unknown property, redirecting to the domain parameter.

	DispatchSetProperty (_.Library.String Property, Val)
	is used to set the value of an unknown property, redirecting to the domain parameter.

Additional Inherited Members
Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT 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.

This class represents a domain registered in this namespace.

When creating a domain, you should pass a value for <property>Name</property> to its <method>New</method> method.

Member Function Documentation

◆ OnNew()

_.Library.Status OnNew	(	_.Library.String	pName,
		_.Library.String	pBuildFlags
	)

Instantiates a new Domain object iwth the given domain name.

pBuildFlags is either of "ALL" or "MINIMAL". An emtpy value will result in the system default being used.

◆ Create()

_.iKnow.Domain Create	(	_.Library.String	name,
		_.Library.Integer	sortField,
		_.Library.Status	sc,
		_.Library.String	buildFlags
	)

static

Creates a domain with the specified domain name in the given namespace.

If no value is

supplied for sortField, it will assume the system-wide defaults. buildFlags is either of "ALL" or "MINIMAL". An empty value will assume the system default.

Deprecated: use <method>New</method> instead (supplying only the name parameter)

◆ Delete()

_.Library.Status Delete ( _.Library.String domainName )

static

Utility method to delete a domain from the system, including its data, settings.

and system global entries.

Deprecated: use <method>DeleteId</method> instead (accepts domain ID)

◆ DeleteId()

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

static

Utility method to delete a domain from the system, including its data, settings.

and system global entries.

Deprecated: use <method>DeleteId</method> instead

◆ DropData()

_.Library.Status DropData	(	_.Library.Boolean	dropMetadataDefinitions,
		_.Library.Boolean	dropDictionaries,
		_.Library.Boolean	dropTempGlobals,
		_.Library.Boolean	dropSkipLists,
		_.Library.Boolean	dropMetricDefinitions
	)

This method will drop all sources and subsequent indexes from this domain.

Note that it is recommended to call this method separately, before dropping the domain through <method>Delete</method> or <method>DeleteId</method>.

◆ Exists()

_.Library.Boolean Exists ( _.Library.String name )

static

Checks whether a domain with the given name already exists within the namespace.

Deprecated: use <method>NameIndexExists</method> instead

◆ GetCurrentSystemVersion()

_.Library.String GetCurrentSystemVersion ( )

static

Returns the current version of this InterSystems IRIS instance, which is the version of any

newly created domain in this instance. Domains already created in this instance before it was last upgraded or which were imported from other instances through other means, may have earlier versions. To check the version of a particular domain, use the <property>Version</property> property of a <class>iKnow.Domain</class> instance.

◆ GetOrCreateId()

_.Library.Integer GetOrCreateId	(	_.Library.String	name,
		_.Library.Integer	sortField,
		_.Library.Status	sc
	)

static

Shorthand method to get the domain ID for a specific domain name, creating it if it does not

yet exist in this namespace.

Deprecated: use regular <method>New</method> and <method>Save</method> methods instead.

◆ GetParameter()

_.Library.String GetParameter	(	_.Library.String	paramName,
		_.Library.String	definedAt
	)

Returns the value used for parameter paramName for this domain.

This can be a

domain-specific override (definedAt = "DOMAIN"), a namespace-wide default (definedAt = "NAMESPACE") or the hardcoded default (definedat = "DEFAULT")

◆ GetParameters()

_.Library.Status GetParameters ( pParams )

Returns an array pParams containing all the domain parameters registered

for this instance in the form: pParams(paramName) = paramValue.

NOTE: this might include parameters that cannot be modified by end users, but will not include values defined at the namespace level.

◆ GetSystemParameter()

_.Library.String GetSystemParameter ( _.Library.String paramName )

static

Returns the current namespace-wide value for a domain parameter if there is one registered.

See <method>GetParameter</method> for more details on how to fetch the current APPLICABLE parameter for a domain, as this method does not take any domain-specific settings or hardcoded defaults into account.

◆ IsEmpty()

_.Library.Boolean IsEmpty ( )

Returns whether or not a domain is empty.

If there are any entities or remnants of (virtual)

sources, this method will return false.

◆ Open()

_.iKnow.Domain Open	(	_.Library.String	name,
		_.Library.Status	sc
	)

static

Opens a domain object with the specified name.

Deprecated: use <method>NameIndexOpen</method> instead

◆ OpenId()

_.iKnow.Domain OpenId	(	_.Library.Integer	id,
		_.Library.Status	sc
	)

static

Opens a domain object with the specified ID.

Deprecated: use <method>OpenId</method> instead

◆ RegisterImportedDomain()

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

static

This method has been deprecated.

There is no need for "registering" or otherwise marking

domains that have been imported from globals or data files.

◆ Rename()

_.Library.Status Rename	(	_.Library.String	pFrom,
		_.Library.String	pTo
	)

static

This method renames an existing domain named pFrom to pTo,.

if there isn't already a domain with that name in this namespace. The domain ID does not change.

◆ SetSystemParameter()

_.Library.Status SetSystemParameter	(	_.Library.String	paramName,
		_.Library.String	paramValue
	)

static

Registers a domain parameter at the namespace level, for all domains in the current namespace.

If there is already a value registered, call <method>UnsetSystemParameter</method> first to explicitly clear the current value.

Member Data Documentation

◆ DefinitionClass

DefinitionClass

The name of the Domain Definition class managing this domain, if any.

See also <class>iKnow.DomainDefinition</class>.

◆ Id

Id

The automatically generated ID for this domain, which is unique across namespaces.

◆ Name

Name

The name of this domain, which should be unique within the namespace (case-insensitive)

◆ Version

Version

Stores the iKnow data structure version number for this domain.

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ OnNew()

◆ Create()

◆ Delete()

◆ DeleteId()

◆ DropData()

◆ Exists()

◆ GetCurrentSystemVersion()

◆ GetOrCreateId()

◆ GetParameter()

◆ GetParameters()

◆ GetSystemParameter()

◆ IsEmpty()

◆ Open()

◆ OpenId()

◆ RegisterImportedDomain()

◆ Rename()

◆ SetSystemParameter()

Member Data Documentation

◆ DefinitionClass

◆ Id

◆ Name

◆ Version