Package com.aquima.interactions.ds.matching

Class ExtXmlCaseBaseDS

java.lang.Object

com.aquima.interactions.ds.ReportingDS

com.aquima.interactions.ds.matching.ExtXmlCaseBaseDS

All Implemented Interfaces:

IReportingDS, ICaseBaseDS

public class ExtXmlCaseBaseDS
extends ReportingDS
implements ICaseBaseDS

ICaseBaseDS implementation for external match engine XML.

Since:

6.2

Author:

O. Kerpershoek, F. van der Meer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExtXmlCaseBaseDS(IInitializationReport report, IXmlNode caseBaseNode, ICaseProvider caseProvider)

Method Summary

Modifier and Type	Method	Description
int	getCaseThresholdPercentage()	This method returns the default threshold percentage for this casebase's cases.
String	getEntityName()	This method returns the entity name for which this casebase was defined.
String	getKeyField()	This method returns the attribute that should be used to group matching cases on.
int	getMaxKeyResults()	This methods returns the maximum number of scores that should be grouped on a single unique key-field value.
int	getMaxResults()	This method returns the setting which specified the maximum amount of matches that will be returned.
void	iterateCases(ICaseVisitor visitor)	The implementor of this method should invoke the visitor for every case available within this case base.
void	iterateMatchDefinitions(IMatchDefinitionVisitor visitor)	The implementor of this method should invoke the visitor for every available match definition which should be used.
boolean	updateCase(String caseName, ICaseVisitor visitor)	The implementor of this method should invoke the visitor for the named case within this case base.

Methods inherited from class com.aquima.interactions.ds.ReportingDS

addMessage, getCategory, getReport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

addMessage

Constructor Details

ExtXmlCaseBaseDS

protected ExtXmlCaseBaseDS(IInitializationReport report,
 IXmlNode caseBaseNode,
 ICaseProvider caseProvider)

Method Details

getCaseThresholdPercentage

public int getCaseThresholdPercentage()

Description copied from interface: ICaseBaseDS

This method returns the default threshold percentage for this casebase's cases. The value supplied can lie between 0 and 100.

Specified by:

getCaseThresholdPercentage in interface ICaseBaseDS

Returns:

The threshold that should be used for this attribute.

getEntityName

public String getEntityName()

Description copied from interface: ICaseBaseDS

This method returns the entity name for which this casebase was defined.

Specified by:

getEntityName in interface ICaseBaseDS

Returns:

the entity name for this casebase which is never null.

getKeyField

public String getKeyField()

Description copied from interface: ICaseBaseDS

This method returns the attribute that should be used to group matching cases on. Cases with the same value for this attribute will be considered as the same result, where the highest score will be taken as the match score. The key field can optionally be null.

Specified by:

getKeyField in interface ICaseBaseDS

Returns:

the key field attribute name when available, null otherwise.

getMaxResults

public int getMaxResults()

Description copied from interface: ICaseBaseDS

This method returns the setting which specified the maximum amount of matches that will be returned.

Specified by:

getMaxResults in interface ICaseBaseDS

Returns:

the maximum result value between 1 and max-int

getMaxKeyResults

public int getMaxKeyResults()

Description copied from interface: ICaseBaseDS

This methods returns the maximum number of scores that should be grouped on a single unique key-field value.

Specified by:

getMaxKeyResults in interface ICaseBaseDS

Returns:

the maximum number of scores that should be grouped on a single unique key-field value.

iterateCases

public void iterateCases(ICaseVisitor visitor)

Description copied from interface: ICaseBaseDS

The implementor of this method should invoke the visitor for every case available within this case base.

Specified by:

iterateCases in interface ICaseBaseDS

Parameters:

visitor - The case visitor which is used to register the cases on.

iterateMatchDefinitions

public void iterateMatchDefinitions(IMatchDefinitionVisitor visitor)

Description copied from interface: ICaseBaseDS

The implementor of this method should invoke the visitor for every available match definition which should be used. A match definition are settings on a per attribute basis within the case base which can be used by the match engine. The match settings are stored on a case base level per attribute.

Specified by:

iterateMatchDefinitions in interface ICaseBaseDS

Parameters:

visitor - The match definition visitor which can be used to register the match definitions on.

updateCase

public boolean updateCase(String caseName,
 ICaseVisitor visitor)

Description copied from interface: ICaseBaseDS

The implementor of this method should invoke the visitor for the named case within this case base.

Specified by:

updateCase in interface ICaseBaseDS

Parameters:

caseName - the name of the case to visit

visitor - the case visitor which is used to register the case on.

Returns:

true if the case is inserted.