IFindBuilder Class Reference

Inheritance diagram for IFindBuilder:

Collaboration diagram for IFindBuilder:

Public Member Functions
_.Library.Status	OnCreateExportTable (_.Dictionary.ClassDefinition pClassDef, _.Library.Boolean pVerbose)
	Callback invoked by <method>ExportDataTable</method> when creating the export table definition.
_.Library.Status	OnExportTable (_.Library.String pClassName, _.Library.Boolean pVerbose, _.Library.Boolean pTracking)
	Callback invoked by <method>ExportDataTable</method> to load the data into export table <class>pClassName</class>.
Public Member Functions inherited from Builder
_.Library.Status	OnGenerateClassifier (_.iKnow.Classification.Definition.Classifier pDefinition, _.Library.Boolean pVerbose, _.Library.Boolean pIncludeBuilderInfo)
	Appends the ClassificationMethod element for this type of classifier.
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
	CategoryColumn
	More...
	ClassName
	More...
	IdColumn
	More...
	IndexName
	More...
	TableName
	More...
	TextColumn
	More...
	TrainingSet
	More...
Public Attributes inherited from Builder
	ClassificationMethod
	The general method used for classification: More...
	Description
	Optional description for the Classifier. More...
	DocumentVectorLocalWeights
	Local Term Weights for the document vector to register in the ClassificationMethod element. More...
	DocumentVectorNormalization
	Document vector normalization method to register in the Classification element. More...
	MinimumSpread
	The minimum number of records in the training set that should contain a term before it. More...
	MinimumSpreadPercent
	The minimum fraction of records in the training set that should contain a term before it. More...

Private Member Functions
_.Library.Status	GetCategoryInfo (pCategories)
	Returns all categories added so far: More...
_.Library.Status	LoadCategoriesFromColumn (_.Library.String pExpression)
	Loads categories based on the value of the supplied SQL expression. More...
_.Library.Status	TestClassifier (_.Library.RawString pTestSet, pResult, _.Library.Double pAccuracy, _.Library.String pCategorySpec, _.Library.Boolean pVerbose)

Private Attributes
	__ProjectionBase
	More...

Additional Inherited Members
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...

Member Function Documentation

GetCategoryInfo()

_.Library.Status GetCategoryInfo (   pCategories )

private

Returns all categories added so far:

   pCategories(n) = $lb([name], [record count])

Reimplemented from Builder.

LoadCategoriesFromColumn()

_.Library.Status LoadCategoriesFromColumn ( _.Library.String  pExpression )

private

Loads categories based on the value of the supplied SQL expression.

pExpression should either be the (SQL) name of a column on <property>TableName</property>, or a valid SQL expression that can be selected from that table (aliased as if required "t").

TestClassifier()

_.Library.Status TestClassifier ( _.Library.RawString  pTestSet,   pResult, _.Library.Double  pAccuracy, _.Library.String  pCategorySpec, _.Library.Boolean  pVerbose  )

private

Utility method to batch-test the classifier against a test set pTestSet, which can

be supplied as a valid SQL WHERE clause to be queried against <property>TableName</property>. Per-record results are returned through pResult:
pResult(n) = $lb([record ID], [actual category], [predicted category])

pAccuracy will contain the raw accuracy (# of records predicted correctly) of the current model. Use <class>iKnow.Classificaton.Utils</class> for more advanced model testing.

If the current model's category options were added through <method>AddCategory</method> without providing an appropriate category specification (again through a SQL WHERE clause), rather than through a call to <class>LoadCategoriesFromColumn</class> (which sets <property>CategoryColumn</property>), supply a column name or SQL expression through pCategorySpec where the actual category values to test against can be found.

Reimplemented from Builder.

Member Data Documentation

CategoryColumn

CategoryColumn

 

 

ClassName

ClassName

 

 

IdColumn

IdColumn

 

 

IndexName

IndexName

 

 

__ProjectionBase

__ProjectionBase

private

 

 

TableName

TableName

 

 

TextColumn

TextColumn

 

 

TrainingSet

TrainingSet