Analytic Class Reference

Inheritance diagram for Analytic:

Collaboration diagram for Analytic:

Additional Inherited Members
Static Public Member Functions inherited from Basic
_.Library.String	Highlight (_.Library.RawString pRecordID, _.Library.String pSearchString, _.Library.String pSearchOption, _.Library.String pTags, _.Library.Integer pLimit, _.Library.Status pSC)
_.Library.Float	Rank (_.Library.RawString pRecordID, _.Library.String pSearchString, _.Library.String pSearchOption)
_.Library.String	StripCharacters (_.Library.String pWord)
	Utility method stripping punctuation characters from the start and end of a word, according to. More...
_.Library.String	StrippedEntityId (_.Library.String pEntity)
	Returns the Entity ID for pEntity, after stripping off any punctuation at the start and end of. More...
_.Library.String	StrippedWordId (_.Library.String pWord)
	Returns the Word ID for pWord, after stripping off any punctuation at the start and end of. More...
Static Public Member Functions inherited from Minimal
	DeleteIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Deletes the iFind index for the row.
_.Library.RegisteredObject	Embedded ()
	Return an instance of the embedded Find class, initialized with the index' parameters.
_.Library.Binary	Find (_.Library.Binary pSearch, _.Library.Integer pOption, _.Library.String pLanguage, _.Library.String pSynonymOption)
	Searches for matches based on the iFind index. More...
	InsertIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Inserts the iFind index for the row. More...
_.Library.String	Normalize (_.Library.String pQuery, _.Library.String pLanguage)
	This method will normalize the query of iFind.Find.Basic based on the dictionary defined iFind.Index.Basic.
	PurgeIndex ()
	Purges the iFind index.
	UpdateIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Updates the iFind index for the row.
Static Public Member Functions inherited from FunctionalIndex
	DeleteIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when an existing instance of a class is deleted.
	InsertIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when a new instance of a class is inserted into the database.
	SegmentFinalize (_.Library.RawString pIndexBuffer, _.Library.RawString pStartID, _.Library.RawString pEndID)
	This method is called when the index builder is finalizing a segment. More...
	SegmentInitialize (_.Library.RawString pIndexBuffer, _.Library.RawString pStartID, _.Library.RawString pEndID)
	This method is called by the parallel index build to initialize an index segment when constructing. More...
	UpdateIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when an existing instance of a class is updated.
Static Public Attributes inherited from Semantic
	IFINDATTRIBUTES = None
Static Public Attributes inherited from Basic
	KEEPCHARS = None
	RANKERCLASS = None
Static Public Attributes inherited from Minimal
	IFINDADVANCEDSQLPREFIX = None
	IFINDMAPPINGS = None
	IFINDSHAREDDATALOCATION = None
	This parameter enables specifying whether words, entities and similar data should be written. More...
	IGNOREPUNCTUATION = None
	INDEXOPTION = None
	Specific indexing options to use when processing records. More...
	LANGUAGE = None
	Language to use when indexing records. More...
	LOWER = None
	Whether or not to convert content to lowercase before indexing. More...
	STEMMINGCONFIG = None
	SUPPORTSSHARDING = None
	This parameter can be set to 1 if the implementation of the filing interface and the SQL query interface can be. More...
	TRANSFORMATIONSPEC = None
	USERDICTIONARY = None
Static Public Attributes inherited from FunctionalIndex
	SUPPORTSSHARDING = None
	This parameter can be set to 1 if the implementation of the filing interface and the SQL query interface can be. More...

Detailed Description

The InterSystems IRIS NLP iKnow technology on which this index type is based is now deprecated. Please see the product documentation for more detail. The <class>iKnow.Index.Basic</class> and <class>iKnow.Index.Minimal</class> index types remain fully supported.

This index class is a more advanced version of <class>iFind.Index.Semantic</class>, leveraging even more output of the iKnow engine. In addition to the core semantic information (entities and attributes), this index type will also save path, proximity and dominance information.

If the <parameter>IFINDMAPPINGS</parameter> index is set to 1 (the default for this type of index), the following additional SQL projections will be generated:

• [class_name]_[index_name]_Path: stores the entities making up a path in each record as individual rows. See also <class>iFind.Index.AbstractPath</class>.
• [class_name]_[index_name]_PathVal: stores the entities making up a path in each record as a list. See also <class>iFind.Index.AbstractPathVal</class>.
• [class_name]_[index_name]_Prox: stores the proximity score for each pair of entities in each record. See also <class>iFind.Index.AbstractProximity</class>.
• [class_name]_[index_name]_Dom: stores the dominance information for each entity in each record. See also <class>iFind.Index.AbstractDominance</class>.

For a detailed description of the other configuration and query options, see the class reference for <class>iFind.Index.Basic</class> and <class>iFind.Index.Semantic</class>.