iKnow utility methods, available through the $system syntax from the command line. More...

Inheritance diagram for iKnow:

Collaboration diagram for iKnow:

Static Public Member Functions
_.Library.Status	DeleteSource (_.Library.String pDomainName, _.Library.Integer pSrcId)
	iKnow utility methods, available through the $system syntax from the command line. More...

_.Library.Status	DeleteVirtualSource (_.Library.String pDomainName, _.Library.Integer vSrcId)
	Deletes the virtual source with ID vSrcId from domain pDomainName

_.Library.Integer	DropData (_.Library.String pDomainName, _.Library.Boolean pDropMetadataFields, _.Library.Boolean pDropDictionaries)
	Drops all of a Domain's contents.

_.Library.Integer	GetDomainId (_.Library.String pDomainName)
	Returns the ID corresponding to the supplied domain name in pDomainName More...

_.Library.String	GetDomainName (_.Library.Integer pDomainId)
	Returns the name corresponding to the supplied domain ID or "" if none found in this namespace.

_.Library.String	GetExternalId (_.Library.String pDomainName, _.Library.Integer pSourceId)
	Returns the External ID for a given pSourceId in domain pDomainName,. More...

_.Library.Integer	GetSourceId (_.Library.String pDomainName, _.Library.String pExternalId)
	Returns the Source ID for a given pExternalId in domain pDomainName,. More...

_.Library.String	Highlight (_.Library.String pText, pHighlight, _.Library.String pConfig, _.Library.Boolean pEscapeHTML, _.Library.Status pSC)
	Highlights the supplied text pText using the highlight information specified through. More...

_.Library.Status	IndexDirectory (_.Library.String pDomainName, _.Library.String pPath, _.Library.Boolean pRecurse, _.Library.String pConfig, _.Library.String pEncoding, _.Library.List pExtensions)
	Indexes the supplied file and stores the indexing results in domain pDomainName. More...

_.Library.Status	IndexFile (_.Library.String pDomainName, _.Library.String pPath, _.Library.String pConfig, _.Library.String pEncoding, _.Library.Integer pSrcId)
	Indexes the supplied file and stores the indexing results in domain pDomainName,. More...

_.Library.Status	IndexString (_.Library.String pDomainName, _.Library.String pIdentifier, _.Library.String pString, _.Library.String pConfig, _.Library.Boolean pVirtual, _.Library.Integer pSrcId)
	Indexes the supplied pString and stores the results into the domain. More...

_.Library.Status	IndexTable (_.Library.String pDomainName, _.Library.String pTableName, _.Library.String pIdField, _.Library.String pGroupField, _.Library.String pDataField, _.Library.List pMetaFields, _.Library.String pWhereClause, _.Library.String pConfig)

_.Library.Status	ListConfigurations ()
	Print a list of all the configurations within this namespace.

_.Library.Status	ListDomains (_.Library.Boolean currentNamespaceOnly)
	Print a list of all the domains within this namespace.

_.Library.Status	ListErrors (_.Library.String pDomainName, _.Library.Integer pLimit)
	Prints the first pLimit load errors, failures and warnings for domain pDomainName. More...

_.Library.Status	ListMetadata (_.Library.String pDomainName, _.Library.Boolean pIncludeHidden)
	Print a list of all metadata fields for a given namespace.

_.Library.String	Normalize (_.Library.String pString, _.Library.Integer pDomainId, _.Library.String pConfig, _.Library.String pLanguage, _.Library.Status pSC, _.Library.Boolean pCleanPunctuation)

	Shell ()
	Run the iKnow shell. More...

Static Public Member Functions inherited from Help
_.Library.String	Help (_.Library.String method)
	This is a helper class that is used by the various SYSTEM classes to provide a Help method. More...

Detailed Description

iKnow utility methods, available through the $system syntax from the command line.

For example: "do $system.iKnow.ListDomains()"

Member Function Documentation

◆ DeleteSource()

_.Library.Status DeleteSource	(	_.Library.String	pDomainName,
		_.Library.Integer	pSrcId
	)

static

iKnow utility methods, available through the $system syntax from the command line.

For example: "do $system.iKnow.ListDomains()"

Deletes the source with internal ID pSrcId from domain pDomainName

◆ GetDomainId()

_.Library.Integer GetDomainId ( _.Library.String pDomainName )

static

Returns the ID corresponding to the supplied domain name in pDomainName

or "" if none found in this namespace.

◆ GetExternalId()

_.Library.String GetExternalId	(	_.Library.String	pDomainName,
		_.Library.Integer	pSourceId
	)

static

Returns the External ID for a given pSourceId in domain pDomainName,.

or the empty string if no source exists with that Source ID.

◆ GetSourceId()

_.Library.Integer GetSourceId	(	_.Library.String	pDomainName,
		_.Library.String	pExternalId
	)

static

Returns the Source ID for a given pExternalId in domain pDomainName,.

or the empty string if no source exists with that External ID.

◆ Highlight()

_.Library.String Highlight	(	_.Library.String	pText,
			pHighlight,
		_.Library.String	pConfig,
		_.Library.Boolean	pEscapeHTML,
		_.Library.Status	pSC
	)

static

Highlights the supplied text pText using the highlight information specified through.

pHighlight. See <method>GetHighlighted</method> in <class>iKnow.Queries.SentenceAPI</class> for more details on possible input to pHighlight.

◆ IndexDirectory()

_.Library.Status IndexDirectory	(	_.Library.String	pDomainName,
		_.Library.String	pPath,
		_.Library.Boolean	pRecurse,
		_.Library.String	pConfig,
		_.Library.String	pEncoding,
		_.Library.List	pExtensions
	)

static

Indexes the supplied file and stores the indexing results in domain pDomainName.

The full path of the files indexed will be used to build the External ID (cf <class>iKnow.Source.File.Lister</class>)

◆ IndexFile()

_.Library.Status IndexFile	(	_.Library.String	pDomainName,
		_.Library.String	pPath,
		_.Library.String	pConfig,
		_.Library.String	pEncoding,
		_.Library.Integer	pSrcId
	)

static

Indexes the supplied file and stores the indexing results in domain pDomainName,.

returning the generated source ID as pSrcId. The full path of the files indexed will be used to build the External ID (cf <class>iKnow.Source.File.Lister</class>)

◆ IndexString()

_.Library.Status IndexString	(	_.Library.String	pDomainName,
		_.Library.String	pIdentifier,
		_.Library.String	pString,
		_.Library.String	pConfig,
		_.Library.Boolean	pVirtual,
		_.Library.Integer	pSrcId
	)

static

Indexes the supplied pString and stores the results into the domain.

pDomainName, using pIdentifier to construct the External ID (cf <class>iKnow.Source.Temp.Lister</class>). The generated sources ID will be returned through pSrcId.

◆ IndexTable()

_.Library.Status IndexTable	(	_.Library.String	pDomainName,
		_.Library.String	pTableName,
		_.Library.String	pIdField,
		_.Library.String	pGroupField,
		_.Library.String	pDataField,
		_.Library.List	pMetaFields,
		_.Library.String	pWhereClause,
		_.Library.String	pConfig
	)

static

Indexes the contents of the pDataField column in table pTableName,

using the pIdField and pGroupField columns to build the external ID for this record (cf <class>iKnow.Source.SQL.Lister</class>). pDomainName can be a (SQL) constant, such as "'MyGroup'". The results are stored in the domain pDomainName.

Optionally, specify a <class>List</class> of table field names through pMetaFields that should be loaded as metadata for the table records.

◆ ListErrors()

_.Library.Status ListErrors	(	_.Library.String	pDomainName,
		_.Library.Integer	pLimit
	)

static

Prints the first pLimit load errors, failures and warnings for domain pDomainName.

Use pLimit=0 to display all errors.

◆ Normalize()

_.Library.String Normalize	(	_.Library.String	pString,
		_.Library.Integer	pDomainId,
		_.Library.String	pConfig,
		_.Library.String	pLanguage,
		_.Library.Status	pSC,
		_.Library.Boolean	pCleanPunctuation
	)

static

Applies relevant iKnow normalization logic. By default, this implies removing whitespace

from the front and back of the string, removing duplicate whitespace, and lowercase. For specific configurations or languages such as Japanese, normalization behaviour is more refined and described in the documentation.

If a domain ID is specified through pDomainId, its default configuration will be used (if specified). Otherwise, the configuration named pConfig will be used.

◆ Shell()

Shell ( )

static

Run the iKnow shell.

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ DeleteSource()

◆ GetDomainId()

◆ GetExternalId()

◆ GetSourceId()

◆ Highlight()

◆ IndexDirectory()

◆ IndexFile()

◆ IndexString()

◆ IndexTable()

◆ ListErrors()

◆ Normalize()

◆ Shell()