iFind Class Reference

Inheritance diagram for iFind:

Collaboration diagram for iFind:

Public Member Functions
_.Library.Status	MatchSingle (_.Library.String string, _.Library.List formatParams, _.Library.Numeric matchScore, matchedWordBits, _.Library.Boolean isScattered, formatOutput)
Public Member Functions inherited from Format
_.Library.Status	Finalize ()
_.Library.Boolean	HasMatchAll ()
_.Library.Status	MatchAll (_.Library.String stringsGlobalName, _.Library.String resultGlobalName, _.Library.List formatParams, _.Library.Integer minEntUniId)
_.Library.Status	MatchAllHashes (_.Library.String hashGlobalName, _.Library.String idGlobalName, _.Library.String resultGlobalName, _.Library.List formatParams, _.Library.Integer minEntUniId)
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...

Additional Inherited Members
Static Public Member Functions inherited from Format
_.Library.Status	TestParams (_.Library.List pFormatParams, _.Library.Integer pDomainId)
	Utility method subclasses can implement to verify user-supplied format parameters are. More...
Public Attributes inherited from Format
	DomainId
	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

This <class>iKnow.Matching.Formats.Format</class> implementation enables users to use the iFind search syntax as a pattern to locate matching entities in an iKnow domain. Please bear in mind that iFind is meant for search scenario's (when looking up records matching the search string), whereas iKnow matching is meant for annotation scenario's (to identify all matches of a search string in a full domain).

Note: matches are only detected within entities and are case-insensitive.

Format parameters:

1. iFind expression (<class>String</class>, mandatory):

Member Function Documentation

MatchSingle()

_.Library.Status MatchSingle	(	_.Library.String	string,
		_.Library.List	formatParams,
		_.Library.Numeric	matchScore,
			matchedWordBits,
		_.Library.Boolean	isScattered,
			formatOutput
	)

Implementations of this method check whether an individual string complies with the format

this class represents, returning a matchScore (0..1) and optional matchedWordBits, isScattered and formatOutput through output parameters.

Reimplemented from Format.