com.exalead.mot.components

Class IdentityMatcher

java.lang.Object

com.exalead.gni.GNIObject

com.exalead.mot.core.Processor

com.exalead.mot.components.IdentityMatcher

public class IdentityMatcher
extends Processor

The IdentityMatcher is a fuzzy expression matcher allowing terms to be: - missing - added - transposed - modified It can only work with a small amount of text, like a query, and not on a full document. It computes a damerau-levenshtein distance between its resource's expressions and the user input at the word-level. So having an expression "word1 word2 word3", and querying with: - "word1" will match with distance=2 (2 terms are missing) - "word1 word3 word2", will match with distance=1 (2 terms have been transposed) - "word1 word2 word4", will match with distance=1 (1 term has been substitute) - "word1 word2 word3 word4", will match with a distance=1 (1 term has been added) Each expression is a rule with 2 parts, a mandatory part called "and atoms" and an optional part call "opt atoms"

Field Summary

Fields

Modifier and Type	Field and Description
boolean	computeAndAtom compute the and atoms
boolean	computeDistance compute the distance
boolean	computeOptAtom compute the opt atoms
double	costDeletion deletion cost
double	costInsertion insertion cost
double	costSubstitution substitution cost
double	costTransposition transposition cost
boolean	keepLongestMatchOnly keep the longest match only
java.lang.String	linkWordTag link/stop word tag (if null, relatedtermspreprocessor's link words are used)
boolean	noOverlapInAndAtoms avoid and atoms overlapping
boolean	noOverlapInOptAtoms avoid opt atoms overlapping
boolean	oneMatchPerAtomOnlyOnAnd forbid an annotation to be used by several and atoms
boolean	oneMatchPerAtomOnlyOnOpt forbid an annotation to be used by several opt atoms
java.lang.String	resource The processor resource

Fields inherited from class com.exalead.mot.core.Processor

fields, name

Constructor Summary

Constructors

Constructor and Description
IdentityMatcher(java.lang.String name, java.lang.String resource, java.lang.String fields)

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
void	init(java.lang.String name, java.lang.String[] fields) Initialize the processor
IdentityMatcherResult[]	results() Get all matching expressions Must be called after pipe.endDocument().
IdentityMatcherResult[]	results(float maxDistance, int minCovering, int minCoveringIncludingOpt, int minCoveringIncludingOptNoLinkWord) Get all matching expressions Must be called after pipe.endDocument()

Methods inherited from class com.exalead.mot.core.Processor

checkResource, destroy, getName, init

Methods inherited from class com.exalead.gni.GNIObject

printInternalCppPointer

Methods inherited from class java.lang.Object

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

Field Detail

resource

public java.lang.String resource

The processor resource

computeDistance

public boolean computeDistance

compute the distance

computeAndAtom

public boolean computeAndAtom

compute the and atoms

computeOptAtom

public boolean computeOptAtom

compute the opt atoms

costInsertion

public double costInsertion

insertion cost

costDeletion

public double costDeletion

deletion cost

costSubstitution

public double costSubstitution

substitution cost

costTransposition

public double costTransposition

transposition cost

linkWordTag

public java.lang.String linkWordTag

link/stop word tag (if null, relatedtermspreprocessor's link words are used)

oneMatchPerAtomOnlyOnAnd

public boolean oneMatchPerAtomOnlyOnAnd

forbid an annotation to be used by several and atoms

oneMatchPerAtomOnlyOnOpt

public boolean oneMatchPerAtomOnlyOnOpt

forbid an annotation to be used by several opt atoms

noOverlapInAndAtoms

public boolean noOverlapInAndAtoms

avoid and atoms overlapping

noOverlapInOptAtoms

public boolean noOverlapInOptAtoms

avoid opt atoms overlapping

keepLongestMatchOnly

public boolean keepLongestMatchOnly

keep the longest match only

Constructor Detail

IdentityMatcher

public IdentityMatcher(java.lang.String name,
                       java.lang.String resource,
                       java.lang.String fields)

Method Detail

init

public void init(java.lang.String name,
                 java.lang.String[] fields)

Initialize the processor

Specified by:

init in class Processor

Parameters:

name - Its name

fields - The list of fields on which it's active

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

results

public IdentityMatcherResult[] results()

Get all matching expressions Must be called after pipe.endDocument().

Returns:

The list of matching expressions

results

public IdentityMatcherResult[] results(float maxDistance,
                                       int minCovering,
                                       int minCoveringIncludingOpt,
                                       int minCoveringIncludingOptNoLinkWord)

Get all matching expressions Must be called after pipe.endDocument()

Parameters:

maxDistance - The maximum distance a match must have to be selected

minCovering - The minimum covering a match must have to be selected

minCoveringIncludingOpt - The minimum covering including optional atoms a match must have to be selected

minCoveringIncludingOptNoLinkWord - The minimum covering including optional atoms but avoiding stop words a match must have to be selected

Returns:

The list of matching expressions