Package de.uni_trier.wi2.procake.similarity.base.collection.impl

Class SMListCorrectnessImpl

java.lang.Object

de.uni_trier.wi2.procake.similarity.impl.SimilarityMeasureImpl

de.uni_trier.wi2.procake.similarity.base.collection.impl.SMCollectionImpl

de.uni_trier.wi2.procake.similarity.base.collection.impl.SMListCorrectnessImpl

All Implemented Interfaces:

SMCollection, SMListCorrectness, SimilarityMeasure

public class SMListCorrectnessImpl
extends SMCollectionImpl
implements SMListCorrectness

Author:

Maximilian Hoffmann CorrectnessMetric, Alexander Schultheis

Field Summary

Fields inherited from class de.uni_trier.wi2.procake.similarity.base.collection.impl.SMCollectionImpl

similarityToUse

Fields inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure

COMPONENT, COMPONENT_KEY, LOG_ORDER_NAME_NOT_FOUND

Fields inherited from interface de.uni_trier.wi2.procake.similarity.base.collection.SMCollection

LOG_ATTRIBUTE_NAME_NOT_FOUND

Fields inherited from interface de.uni_trier.wi2.procake.similarity.base.collection.SMListCorrectness

DEFAULT_DISCORDANT_PARAMETER, NAME

Constructor Summary

Constructors

Constructor	Description
SMListCorrectnessImpl()

Method Summary

Modifier and Type	Method	Description
Similarity	compute(DataObject queryObject, DataObject caseObject, SimilarityValuator valuator)
double	getDiscordantParameter()	Returns the double parameter, which specifies the maximum similarity if only discordant pairs exists.
String	getSystemName()	The system name can be used to distinguish the similarity measures.
boolean	isSimilarityFor(DataClass dataclass, String orderName)
void	setDiscordantParameter(double discordantParameter)	Setting a parameter, that specifies, how the similarity is evaluated if there are more discordant than concordant pairs.

Methods inherited from class de.uni_trier.wi2.procake.similarity.base.collection.impl.SMCollectionImpl

checkStoppingCriteria, getCollectionClass, getSimilarityToUse, initializeBasedOn, setSimilarityToUse

Methods inherited from class de.uni_trier.wi2.procake.similarity.impl.SimilarityMeasureImpl

getDataClass, getName, initialize, isAggregate, isForceOverride, isInterval, isNumeric, isObject, isReusable, isSet, isTable, isTaxonomy, isText, setDataClass, setForceOverride, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure

getDataClass, getName, isForceOverride, isReusable, setForceOverride

Methods inherited from interface de.uni_trier.wi2.procake.similarity.base.collection.SMCollection

getSimilarityToUse, setSimilarityToUse

Constructor Detail

SMListCorrectnessImpl

public SMListCorrectnessImpl()

Method Detail

compute

public Similarity compute(DataObject queryObject,
                          DataObject caseObject,
                          SimilarityValuator valuator)

Specified by:

compute in interface SimilarityMeasure

Returns:

setDiscordantParameter

public void setDiscordantParameter(double discordantParameter)

Description copied from interface: SMListCorrectness

Setting a parameter, that specifies, how the similarity is evaluated if there are more discordant than concordant pairs. By default, this parameter is set to 1.0 and decreases linearly. This means that only discordant pairs have a similarity of 1.0. The parameter can be in the interval 1.0 to 0.0.

Specified by:

setDiscordantParameter in interface SMListCorrectness

Parameters:

discordantParameter - A double parameter, which specifies the maximum similarity if only discordant pairs exists.

getDiscordantParameter

public double getDiscordantParameter()

Description copied from interface: SMListCorrectness

Returns the double parameter, which specifies the maximum similarity if only discordant pairs exists.

Specified by:

getDiscordantParameter in interface SMListCorrectness

Returns:

A double parameter, which specifies the maximum similarity if only discordant pairs exists.

isSimilarityFor

public boolean isSimilarityFor(DataClass dataclass,
                               String orderName)

Overrides:

isSimilarityFor in class SMCollectionImpl

getSystemName

public String getSystemName()

Description copied from interface: SimilarityMeasure

The system name can be used to distinguish the similarity measures. Each similarity measure that can be instantiated contains a static final field called NAME representing the system name, e.g., SMAggregateEuclidian.NAME

The system name must also be given during initialization, see SimilarityModel.createSimilarityMeasure(String, DataClass).

Specified by:

getSystemName in interface SimilarityMeasure

Returns:

The system name of the similarity measure. This is equal to SimilarityMeasure.NAME.