RegularExpression Class Reference

Inheritance diagram for RegularExpression:

Collaboration diagram for RegularExpression:

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...

Public Attributes
	Matcher
	More...
Public Attributes inherited from Format
	DomainId
	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...
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 implements Regular Expression matching as an implementation for <class>iKnow.Matching.Formats.Format</class>, leveraging the ICU implementation in <class>Regex.Matcher</class>. This implementation does not support matched word indicators, scattered match detection or anything but boolean match scores. Also, it will only verify within entities and therefore never find matches that cross an entity boundary.

Format parameters:

1. regular expression (<class>String</class>, mandatory): the regular expression to pass to the <class>Regex.Matcher</class> object.
2. replacement string (<class>String</class>, default ""): if supplied, formatOutput will be populated by running this replacement string against the text and expression pair
3. replace all (<class>Boolean</class>, default 1): if set to 0, formatOutput will contain the result of ReplaceFirst() rather than ReplaceAll() when using replace functionality

Member Function Documentation

MatchSingle()

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

This class implements Regular Expression matching as an implementation for <class>iKnow.Matching.Formats.Format</class>, leveraging the ICU implementation in <class>Regex.Matcher</class>. This implementation does not support matched word indicators, scattered match detection or anything but boolean match scores. Also, it will only verify within entities and therefore never find matches that cross an entity boundary.

Format parameters:

1. regular expression (<class>String</class>, mandatory): the regular expression to pass to the <class>Regex.Matcher</class> object.
2. replacement string (<class>String</class>, default ""): if supplied, formatOutput will be populated by running this replacement string against the text and expression pair
3. replace all (<class>Boolean</class>, default 1): if set to 0, formatOutput will contain the result of ReplaceFirst() rather than ReplaceAll() when using replace functionality

Reimplemented from Format.

Member Data Documentation

Matcher

Matcher