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

Class SMTableDataClassImpl

java.lang.Object

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

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

All Implemented Interfaces:

SMTableDataClass, SimilarityMeasure

public class SMTableDataClassImpl
extends SimilarityMeasureImpl
implements SMTableDataClass

Author:

Rainer Maximini

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<DataClass,Map<DataClass,Similarity>>	queryCaseSim

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.SMTableDataClass

DEFAULT_SIMILARITY, DEFAULT_SYMMETRIC, NAME

Constructor Summary

Constructors

Constructor	Description
SMTableDataClassImpl()

Method Summary

Modifier and Type	Method	Description
void	addSimilarity(DataClass queryDataClass, DataClass caseDataClass, double similarity)	Adds a similarity value for the given data classes.
Similarity	compute(DataObject queryObject, DataObject caseObject, SimilarityValuator valuator)
DataClass[]	getCaseDataClasses(DataClass forQuery)
double	getDefaultSim()
DataClass[]	getQueryDataClasses()
Similarity	getSimilarity(DataClass queryDataClass, DataClass caseDataClass)
String	getSystemName()	The system name can be used to distinguish the similarity measures.
boolean	isSimilarityFor(DataClass dataclass, String orderName)
boolean	isSymmetric()
void	removeSimilarity(DataClass queryDataClass, DataClass caseDataClass)	Removes the similarity value for the given query and case class name.
void	setDefaultSim(double defaultSim)	Sets the default similarity value that is used if no similarity value for the given query and case is defined.
void	setSymmetric(boolean symmetric)

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

Field Detail

queryCaseSim

protected final Map<DataClass,Map<DataClass,Similarity>> queryCaseSim

Constructor Detail

SMTableDataClassImpl

public SMTableDataClassImpl()

Method Detail

addSimilarity

public void addSimilarity(DataClass queryDataClass,
                          DataClass caseDataClass,
                          double similarity)

Description copied from interface: SMTableDataClass

Adds a similarity value for the given data classes.

Specified by:

addSimilarity in interface SMTableDataClass

Parameters:

queryDataClass - The data class for the query.

caseDataClass - The data class for the case.

similarity - The similarity value.

compute

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

Specified by:

compute in interface SimilarityMeasure

Returns:

getCaseDataClasses

public DataClass[] getCaseDataClasses(DataClass forQuery)

Specified by:

getCaseDataClasses in interface SMTableDataClass

Returns:

All case data classes for that and the given query data class name a similarity value is defined.

getDefaultSim

public double getDefaultSim()

Specified by:

getDefaultSim in interface SMTableDataClass

Returns:

The default similarity value.

setDefaultSim

public void setDefaultSim(double defaultSim)

Description copied from interface: SMTableDataClass

Sets the default similarity value that is used if no similarity value for the given query and case is defined.

Specified by:

setDefaultSim in interface SMTableDataClass

getQueryDataClasses

public DataClass[] getQueryDataClasses()

Specified by:

getQueryDataClasses in interface SMTableDataClass

Returns:

All query data class names for that a similarity value is defined.

getSimilarity

public Similarity getSimilarity(DataClass queryDataClass,
                                DataClass caseDataClass)

Specified by:

getSimilarity in interface SMTableDataClass

Returns:

The defined similarity value for the query and case data class. If no mapping for this classes is defined the null value will be returned and NOT the default similarity value.

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.

isSimilarityFor

public boolean isSimilarityFor(DataClass dataclass,
                               String orderName)

Specified by:

isSimilarityFor in class SimilarityMeasureImpl

isSymmetric

public boolean isSymmetric()

Specified by:

isSymmetric in interface SMTableDataClass

Returns:

true if the similarity definitions are symmetric.

setSymmetric

public void setSymmetric(boolean symmetric)

Specified by:

setSymmetric in interface SMTableDataClass

removeSimilarity

public void removeSimilarity(DataClass queryDataClass,
                             DataClass caseDataClass)

Description copied from interface: SMTableDataClass

Removes the similarity value for the given query and case class name. If no similarity value is defined nothing will be removed.

Specified by:

removeSimilarity in interface SMTableDataClass

Parameters:

queryDataClass - the query class to be removed

caseDataClass - the case class to be removed