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

Class SMUnionImpl

java.lang.Object

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

de.uni_trier.wi2.procake.similarity.base.impl.SMUnionImpl

All Implemented Interfaces:

SMUnion, SimilarityMeasure

public class SMUnionImpl
extends SimilarityMeasureImpl
implements SMUnion

Implementation of SMUnion.

Author:

Philipp Geier, Alexander Schultheis

Field Summary

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

LOG_ORDER_NAME_NOT_FOUND

Fields inherited from interface de.uni_trier.wi2.procake.similarity.base.SMUnion

NAME

Constructor Summary

Constructors

Constructor	Description
SMUnionImpl()

Method Summary

Modifier and Type	Method	Description
Similarity	compute(DataObject queryObject, DataObject caseObject, SimilarityValuator similarityValuator)
String	getDefaultSimilarityMeasure()	A method that returns the default similarity measure for all union class objects.
Map	getSimilaritiesToUse()	A method that returns a map containing the mapping of each data class to the similarity measures to be used.
String	getSimilarityToUse(String dataClass)	A method that returns the similarity measure to use for a specific data class.
String	getSystemName()	The system name can be used to distinguish the similarity measures.
boolean	isSimilarityFor(DataClass dataclass, String orderName)
void	setDefaultSimilarityMeasure(String defaultSimilarityMeasure)	A method that specifies the default similarity measure for all union class objects.
void	setSimilarityToUse(String dataClass, String similarityToUse)	A method that adds a similarity measure to use for a specific data class.

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

getDataClass, getName, initialize, initializeBasedOn, 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

Constructor Details

SMUnionImpl

public SMUnionImpl()

Method Details

isSimilarityFor

public boolean isSimilarityFor(DataClass dataclass,
 String orderName)

Specified by:

isSimilarityFor in class SimilarityMeasureImpl

compute

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

Specified by:

compute in interface SimilarityMeasure

Returns:

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.

getSimilaritiesToUse

public Map getSimilaritiesToUse()

Description copied from interface: SMUnion

A method that returns a map containing the mapping of each data class to the similarity measures to be used. If a data class defined in the union class is not included, the global default measure is used or if this is not set, the default measure for the respective data class.

Specified by:

getSimilaritiesToUse in interface SMUnion

Returns:

A map containing the mapping of each data class to the similarity measures to be used.

getSimilarityToUse

public String getSimilarityToUse(String dataClass)

Description copied from interface: SMUnion

A method that returns the similarity measure to use for a specific data class. If no measure is set, then null is returned. If this data class is not contained in the Union class, an exception is thrown.

Specified by:

getSimilarityToUse in interface SMUnion

Parameters:

dataClass - The data class for which the specific similarity measure is searched.

Returns:

The similarity measure to use for a specific data class.

setSimilarityToUse

public void setSimilarityToUse(String dataClass,
 String similarityToUse)

Description copied from interface: SMUnion

A method that adds a similarity measure to use for a specific data class. If this data class is not contained in * the Union class, an exception is thrown. If the usage of the default measure is desired for a data class, no specific similarity to use has to be set.

Specified by:

setSimilarityToUse in interface SMUnion

Parameters:

dataClass - The data class for which the specific similarity measure should be set.

similarityToUse - The name of the similarity measure to use for the given data class.

getDefaultSimilarityMeasure

public String getDefaultSimilarityMeasure()

Description copied from interface: SMUnion

A method that returns the default similarity measure for all union class objects. If this is set, it will be used in all similarity calculations of objects of this class, unless the data class is overridden by the explicitly set similarity to use. If it is not set, either the locally set measure or the ProCAKE default measure is used.

Specified by:

getDefaultSimilarityMeasure in interface SMUnion

Returns:

default The default similarity measure for all union class objects.

setDefaultSimilarityMeasure

public void setDefaultSimilarityMeasure(String defaultSimilarityMeasure)

Description copied from interface: SMUnion

A method that specifies the default similarity measure for all union class objects. If this is set, it will be used in all similarity calculations of objects of this class, unless the data class is overridden by the explicitly set similarity to use. If it is not set, either the locally set measure or the ProCAKE default measure is used.

Specified by:

setDefaultSimilarityMeasure in interface SMUnion

Parameters:

defaultSimilarityMeasure - The default similarity measure for all union class objects.