Package com.senzing.g2.engine.plugin

Interface G2ScoringPlugin

All Superinterfaces:

G2PluginInterface

public interface G2ScoringPlugin
extends G2PluginInterface

Scores two different features to determine equivalence.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	G2ScoringPlugin.ScoringContext	Context for scoring.

Nested classes/interfaces inherited from interface com.senzing.g2.engine.plugin.G2PluginInterface

G2PluginInterface.InitContext, G2PluginInterface.VersionContext

Field Summary

Fields inherited from interface com.senzing.g2.engine.plugin.G2PluginInterface

PLUGIN_CRITICAL_ERROR, PLUGIN_OUTPUT_BUFFER_SIZE_ERROR, PLUGIN_SIMPLE_ERROR, PLUGIN_SUCCESS, PLUGIN_SUCCESS_WITH_INFO

Method Summary

Modifier and Type	Method	Description
default int	getScoreNames(StringBuilder scoreNames)	Gets the score names as XML.
int	getScoreNames(Set<String> scoreNames)	This method is called to populate the specified Set with the scoring names that will be produced.
int	score(G2ScoringPlugin.ScoringContext context)	Run the feature scoring process

Methods inherited from interface com.senzing.g2.engine.plugin.G2PluginInterface

getVersion, init, shutdown

Method Detail

score

int score(G2ScoringPlugin.ScoringContext context)

Run the feature scoring process

Parameters:

context - The feature scoring context

Returns:

a status code for the feature scoring operation.

getScoreNames

default int getScoreNames(StringBuilder scoreNames)

Gets the score names as XML. The default implementation calls getScoreNames(Set) and constructs the XML from the populated list and appends it to the specified StringBuilder.

Parameters:

scoreNames - The StringBuilder to append the XML to.

Returns:

A non-negative number on success and a negative number on failure.

getScoreNames

int getScoreNames(Set<String> scoreNames)

This method is called to populate the specified Set with the scoring names that will be produced.

Parameters:

scoreNames - The Set to be populated.

Returns:

A non-negative number on success and a negative number on failure.