com.exalead.linguistic.v10

Class IdentityMatcher

java.lang.Object

com.exalead.linguistic.v10.SemanticProcessor

com.exalead.linguistic.v10.IdentityMatcher

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class IdentityMatcher
extends SemanticProcessor
implements com.exalead.util.Checkable, java.io.Serializable

A SemanticProcessor applies semantic processing on the textual content
of the DocumentChunks.
A Semantic Processor creates SemanticAnnotations on tokens.
These SemanticAnnotations can then be used in the Mapping.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.linguistic.v10.SemanticProcessor

SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
boolean	computeAndAtom
boolean	computeDistance
boolean	computeOptAtom
double	costDeletion
double	costInsertion
double	costSubstitution
double	costTransposition
static boolean	DEFAULT_COMPUTE_AND_ATOM
static boolean	DEFAULT_COMPUTE_DISTANCE
static boolean	DEFAULT_COMPUTE_OPT_ATOM
static double	DEFAULT_COST_DELETION
static double	DEFAULT_COST_INSERTION
static double	DEFAULT_COST_SUBSTITUTION
static double	DEFAULT_COST_TRANSPOSITION
static boolean	DEFAULT_KEEP_LONGEST_MATCH_ONLY
static boolean	DEFAULT_NO_OVERLAP_IN_AND_ATOMS
static boolean	DEFAULT_NO_OVERLAP_IN_OPT_ATOMS
static boolean	DEFAULT_ONE_MATCH_PER_ATOM_ONLY_ON_AND
static boolean	DEFAULT_ONE_MATCH_PER_ATOM_ONLY_ON_OPT
boolean	keepLongestMatchOnly
java.lang.String	linkWordTag
boolean	noOverlapInAndAtoms
boolean	noOverlapInOptAtoms
boolean	oneMatchPerAtomOnlyOnAnd
boolean	oneMatchPerAtomOnlyOnOpt
java.lang.String	resourceDir

Fields inherited from class com.exalead.linguistic.v10.SemanticProcessor

contexts, name, src

Constructor Summary

Constructors

Constructor and Description
IdentityMatcher()
IdentityMatcher(IdentityMatcher o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
void	accept(SemanticProcessor.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this IdentityMatcher.
static IdentityMatcher	fromString(java.lang.String s) String representation of this IdentityMatcher.
double	getCostDeletion() Cost of a token deletion.
double	getCostInsertion() Cost of a token insertion.
double	getCostSubstitution() Cost of a token substitution.
double	getCostTransposition() Cost of a token transposition.
java.lang.String	getLinkWordTag() Name of the link word annotation (relatedtermspreprocessor's linkword by default).
java.lang.String	getResourceDir() URL for the resource (data://, file;// or resource://)
boolean	isComputeAndAtom() Computes mandatory atoms.
boolean	isComputeDistance() Determine whether the distance should be computed.
boolean	isComputeOptAtom() Computes optional atoms.
boolean	isKeepLongestMatchOnly() Only the longest match should be kept.
boolean	isNoOverlapInAndAtoms() Overlap is forbidden in the mandatory part.
boolean	isNoOverlapInOptAtoms() Overlap is forbidden in the optional part.
boolean	isOneMatchPerAtomOnlyOnAnd() Atoms can be only consumed once in the mandatory part.
boolean	isOneMatchPerAtomOnlyOnOpt() Atoms can be only consumed once in the optional part.
IdentityMatcher	makeCopy() Creates and returns a deep copy of this IdentityMatcher.
static IdentityMatcher	readFrom(java.io.InputStream is) Read this IdentityMatcher from an XML fragment.
void	setComputeAndAtom(boolean computeAndAtom) Computes mandatory atoms.
void	setComputeDistance(boolean computeDistance) Determine whether the distance should be computed.
void	setComputeOptAtom(boolean computeOptAtom) Computes optional atoms.
void	setCostDeletion(double costDeletion) Cost of a token deletion.
void	setCostInsertion(double costInsertion) Cost of a token insertion.
void	setCostSubstitution(double costSubstitution) Cost of a token substitution.
void	setCostTransposition(double costTransposition) Cost of a token transposition.
void	setKeepLongestMatchOnly(boolean keepLongestMatchOnly) Only the longest match should be kept.
void	setLinkWordTag(java.lang.String linkWordTag) Name of the link word annotation (relatedtermspreprocessor's linkword by default).
void	setNoOverlapInAndAtoms(boolean noOverlapInAndAtoms) Overlap is forbidden in the mandatory part.
void	setNoOverlapInOptAtoms(boolean noOverlapInOptAtoms) Overlap is forbidden in the optional part.
void	setOneMatchPerAtomOnlyOnAnd(boolean oneMatchPerAtomOnlyOnAnd) Atoms can be only consumed once in the mandatory part.
void	setOneMatchPerAtomOnlyOnOpt(boolean oneMatchPerAtomOnlyOnOpt) Atoms can be only consumed once in the optional part.
void	setResourceDir(java.lang.String resourceDir) URL for the resource (data://, file;// or resource://)
java.lang.String	toString() String representation of this IdentityMatcher.
IdentityMatcher	withComputeAndAtom(boolean computeAndAtom)
IdentityMatcher	withComputeAndAtom(java.lang.Boolean computeAndAtom)
IdentityMatcher	withComputeDistance(boolean computeDistance)
IdentityMatcher	withComputeDistance(java.lang.Boolean computeDistance)
IdentityMatcher	withComputeOptAtom(boolean computeOptAtom)
IdentityMatcher	withComputeOptAtom(java.lang.Boolean computeOptAtom)
IdentityMatcher	withContexts(java.lang.String contexts)
IdentityMatcher	withCostDeletion(double costDeletion)
IdentityMatcher	withCostInsertion(double costInsertion)
IdentityMatcher	withCostSubstitution(double costSubstitution)
IdentityMatcher	withCostTransposition(double costTransposition)
IdentityMatcher	withKeepLongestMatchOnly(boolean keepLongestMatchOnly)
IdentityMatcher	withKeepLongestMatchOnly(java.lang.Boolean keepLongestMatchOnly)
IdentityMatcher	withLinkWordTag(java.lang.String linkWordTag)
IdentityMatcher	withName(java.lang.String name)
IdentityMatcher	withNoOverlapInAndAtoms(boolean noOverlapInAndAtoms)
IdentityMatcher	withNoOverlapInAndAtoms(java.lang.Boolean noOverlapInAndAtoms)
IdentityMatcher	withNoOverlapInOptAtoms(boolean noOverlapInOptAtoms)
IdentityMatcher	withNoOverlapInOptAtoms(java.lang.Boolean noOverlapInOptAtoms)
IdentityMatcher	withOneMatchPerAtomOnlyOnAnd(boolean oneMatchPerAtomOnlyOnAnd)
IdentityMatcher	withOneMatchPerAtomOnlyOnAnd(java.lang.Boolean oneMatchPerAtomOnlyOnAnd)
IdentityMatcher	withOneMatchPerAtomOnlyOnOpt(boolean oneMatchPerAtomOnlyOnOpt)
IdentityMatcher	withOneMatchPerAtomOnlyOnOpt(java.lang.Boolean oneMatchPerAtomOnlyOnOpt)
IdentityMatcher	withResourceDir(java.lang.String resourceDir)
IdentityMatcher	withSrc(java.lang.String src) Deprecated.
void	writeTo(java.io.OutputStream os) Write this IdentityMatcher as an XML fragment

Methods inherited from class com.exalead.linguistic.v10.SemanticProcessor

getContexts, getName, getSrc, setContexts, setName, setSrc

Methods inherited from class java.lang.Object

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

Field Detail

resourceDir

public java.lang.String resourceDir

computeDistance

public boolean computeDistance

DEFAULT_COMPUTE_DISTANCE

public static final boolean DEFAULT_COMPUTE_DISTANCE

See Also:

Constant Field Values

computeAndAtom

public boolean computeAndAtom

DEFAULT_COMPUTE_AND_ATOM

public static final boolean DEFAULT_COMPUTE_AND_ATOM

See Also:

Constant Field Values

computeOptAtom

public boolean computeOptAtom

DEFAULT_COMPUTE_OPT_ATOM

public static final boolean DEFAULT_COMPUTE_OPT_ATOM

See Also:

Constant Field Values

costInsertion

public double costInsertion

DEFAULT_COST_INSERTION

public static final double DEFAULT_COST_INSERTION

See Also:

Constant Field Values

costDeletion

public double costDeletion

DEFAULT_COST_DELETION

public static final double DEFAULT_COST_DELETION

See Also:

Constant Field Values

costSubstitution

public double costSubstitution

DEFAULT_COST_SUBSTITUTION

public static final double DEFAULT_COST_SUBSTITUTION

See Also:

Constant Field Values

costTransposition

public double costTransposition

DEFAULT_COST_TRANSPOSITION

public static final double DEFAULT_COST_TRANSPOSITION

See Also:

Constant Field Values

linkWordTag

public java.lang.String linkWordTag

oneMatchPerAtomOnlyOnAnd

public boolean oneMatchPerAtomOnlyOnAnd

DEFAULT_ONE_MATCH_PER_ATOM_ONLY_ON_AND

public static final boolean DEFAULT_ONE_MATCH_PER_ATOM_ONLY_ON_AND

See Also:

Constant Field Values

oneMatchPerAtomOnlyOnOpt

public boolean oneMatchPerAtomOnlyOnOpt

DEFAULT_ONE_MATCH_PER_ATOM_ONLY_ON_OPT

public static final boolean DEFAULT_ONE_MATCH_PER_ATOM_ONLY_ON_OPT

See Also:

Constant Field Values

noOverlapInAndAtoms

public boolean noOverlapInAndAtoms

DEFAULT_NO_OVERLAP_IN_AND_ATOMS

public static final boolean DEFAULT_NO_OVERLAP_IN_AND_ATOMS

See Also:

Constant Field Values

noOverlapInOptAtoms

public boolean noOverlapInOptAtoms

DEFAULT_NO_OVERLAP_IN_OPT_ATOMS

public static final boolean DEFAULT_NO_OVERLAP_IN_OPT_ATOMS

See Also:

Constant Field Values

keepLongestMatchOnly

public boolean keepLongestMatchOnly

DEFAULT_KEEP_LONGEST_MATCH_ONLY

public static final boolean DEFAULT_KEEP_LONGEST_MATCH_ONLY

See Also:

Constant Field Values

Constructor Detail

IdentityMatcher

public IdentityMatcher()

IdentityMatcher

public IdentityMatcher(IdentityMatcher o)

Copy constructor

Method Detail

withName

public IdentityMatcher withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public IdentityMatcher withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withSrc

@Deprecated
public IdentityMatcher withSrc(java.lang.String src)

Deprecated.

Overrides:

withSrc in class SemanticProcessor

setResourceDir

public void setResourceDir(java.lang.String resourceDir)

URL for the resource (data://, file;// or resource://)

getResourceDir

public java.lang.String getResourceDir()

URL for the resource (data://, file;// or resource://)

withResourceDir

public IdentityMatcher withResourceDir(java.lang.String resourceDir)

setComputeDistance

public void setComputeDistance(boolean computeDistance)

Determine whether the distance should be computed.

isComputeDistance

public boolean isComputeDistance()

Determine whether the distance should be computed.

withComputeDistance

public IdentityMatcher withComputeDistance(boolean computeDistance)

withComputeDistance

public IdentityMatcher withComputeDistance(java.lang.Boolean computeDistance)

setComputeAndAtom

public void setComputeAndAtom(boolean computeAndAtom)

Computes mandatory atoms.

isComputeAndAtom

public boolean isComputeAndAtom()

Computes mandatory atoms.

withComputeAndAtom

public IdentityMatcher withComputeAndAtom(boolean computeAndAtom)

withComputeAndAtom

public IdentityMatcher withComputeAndAtom(java.lang.Boolean computeAndAtom)

setComputeOptAtom

public void setComputeOptAtom(boolean computeOptAtom)

Computes optional atoms.

isComputeOptAtom

public boolean isComputeOptAtom()

Computes optional atoms.

withComputeOptAtom

public IdentityMatcher withComputeOptAtom(boolean computeOptAtom)

withComputeOptAtom

public IdentityMatcher withComputeOptAtom(java.lang.Boolean computeOptAtom)

setCostInsertion

public void setCostInsertion(double costInsertion)

Cost of a token insertion.

getCostInsertion

public double getCostInsertion()

Cost of a token insertion.

withCostInsertion

public IdentityMatcher withCostInsertion(double costInsertion)

setCostDeletion

public void setCostDeletion(double costDeletion)

Cost of a token deletion.

getCostDeletion

public double getCostDeletion()

Cost of a token deletion.

withCostDeletion

public IdentityMatcher withCostDeletion(double costDeletion)

setCostSubstitution

public void setCostSubstitution(double costSubstitution)

Cost of a token substitution.

getCostSubstitution

public double getCostSubstitution()

Cost of a token substitution.

withCostSubstitution

public IdentityMatcher withCostSubstitution(double costSubstitution)

setCostTransposition

public void setCostTransposition(double costTransposition)

Cost of a token transposition.

getCostTransposition

public double getCostTransposition()

Cost of a token transposition.

withCostTransposition

public IdentityMatcher withCostTransposition(double costTransposition)

setLinkWordTag

public void setLinkWordTag(java.lang.String linkWordTag)

Name of the link word annotation (relatedtermspreprocessor's linkword by default).

getLinkWordTag

public java.lang.String getLinkWordTag()

Name of the link word annotation (relatedtermspreprocessor's linkword by default).

withLinkWordTag

public IdentityMatcher withLinkWordTag(java.lang.String linkWordTag)

setOneMatchPerAtomOnlyOnAnd

public void setOneMatchPerAtomOnlyOnAnd(boolean oneMatchPerAtomOnlyOnAnd)

Atoms can be only consumed once in the mandatory part.

isOneMatchPerAtomOnlyOnAnd

public boolean isOneMatchPerAtomOnlyOnAnd()

Atoms can be only consumed once in the mandatory part.

withOneMatchPerAtomOnlyOnAnd

public IdentityMatcher withOneMatchPerAtomOnlyOnAnd(boolean oneMatchPerAtomOnlyOnAnd)

withOneMatchPerAtomOnlyOnAnd

public IdentityMatcher withOneMatchPerAtomOnlyOnAnd(java.lang.Boolean oneMatchPerAtomOnlyOnAnd)

setOneMatchPerAtomOnlyOnOpt

public void setOneMatchPerAtomOnlyOnOpt(boolean oneMatchPerAtomOnlyOnOpt)

Atoms can be only consumed once in the optional part.

isOneMatchPerAtomOnlyOnOpt

public boolean isOneMatchPerAtomOnlyOnOpt()

Atoms can be only consumed once in the optional part.

withOneMatchPerAtomOnlyOnOpt

public IdentityMatcher withOneMatchPerAtomOnlyOnOpt(boolean oneMatchPerAtomOnlyOnOpt)

withOneMatchPerAtomOnlyOnOpt

public IdentityMatcher withOneMatchPerAtomOnlyOnOpt(java.lang.Boolean oneMatchPerAtomOnlyOnOpt)

setNoOverlapInAndAtoms

public void setNoOverlapInAndAtoms(boolean noOverlapInAndAtoms)

Overlap is forbidden in the mandatory part.

isNoOverlapInAndAtoms

public boolean isNoOverlapInAndAtoms()

Overlap is forbidden in the mandatory part.

withNoOverlapInAndAtoms

public IdentityMatcher withNoOverlapInAndAtoms(boolean noOverlapInAndAtoms)

withNoOverlapInAndAtoms

public IdentityMatcher withNoOverlapInAndAtoms(java.lang.Boolean noOverlapInAndAtoms)

setNoOverlapInOptAtoms

public void setNoOverlapInOptAtoms(boolean noOverlapInOptAtoms)

Overlap is forbidden in the optional part.

isNoOverlapInOptAtoms

public boolean isNoOverlapInOptAtoms()

Overlap is forbidden in the optional part.

withNoOverlapInOptAtoms

public IdentityMatcher withNoOverlapInOptAtoms(boolean noOverlapInOptAtoms)

withNoOverlapInOptAtoms

public IdentityMatcher withNoOverlapInOptAtoms(java.lang.Boolean noOverlapInOptAtoms)

setKeepLongestMatchOnly

public void setKeepLongestMatchOnly(boolean keepLongestMatchOnly)

Only the longest match should be kept.

isKeepLongestMatchOnly

public boolean isKeepLongestMatchOnly()

Only the longest match should be kept.

withKeepLongestMatchOnly

public IdentityMatcher withKeepLongestMatchOnly(boolean keepLongestMatchOnly)

withKeepLongestMatchOnly

public IdentityMatcher withKeepLongestMatchOnly(java.lang.Boolean keepLongestMatchOnly)

makeCopy

public IdentityMatcher makeCopy()

Creates and returns a deep copy of this IdentityMatcher.

Overrides:

makeCopy in class SemanticProcessor

readFrom

public static IdentityMatcher readFrom(java.io.InputStream is)
                                throws javax.xml.bind.JAXBException

Read this IdentityMatcher from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this IdentityMatcher as an XML fragment

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static IdentityMatcher fromString(java.lang.String s)
                                  throws javax.xml.bind.JAXBException,
                                         java.io.UnsupportedEncodingException

String representation of this IdentityMatcher.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IdentityMatcher.

Overrides:

toString in class SemanticProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this IdentityMatcher.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public void accept(SemanticProcessor.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(SemanticProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException