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

Class SMTableDataObjectImpl

java.lang.Object

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

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

All Implemented Interfaces:

SMTableDataObject, SimilarityMeasure

public class SMTableDataObjectImpl
extends SimilarityMeasureImpl
implements SMTableDataObject

Author:

Rainer Maximini

Field Summary

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

DEFAULT_SIMILARITY, NAME, SYMMETRIC_DEFAULT

Constructor Summary

Constructors

Constructor	Description
SMTableDataObjectImpl()

Method Summary

Modifier and Type	Method	Description
void	addSimilarity(AtomicObject queryObject, AtomicObject caseObject, double similarity)	Adds a similarity measure for the query and case object.
Similarity	compute(DataObject queryObject, DataObject caseObject, SimilarityValuator valuator)
DataObjectIterator	getCaseObjects(AtomicObject query)
DataObjectIterator	getQueryObjects()
Similarity	getSimilarity(AtomicObject queryObject, AtomicObject caseObject)
String	getSystemName()	The system name can be used to distinguish the similarity measures.
boolean	isSimilarityFor(DataClass dataclass, String orderName)
boolean	isSymmetric()
void	removeSimilarity(AtomicObject queryObject, AtomicObject caseObject)	Removes the similarity value for the given query and case object.
void	setSymmetric(boolean symmetric)	The similarity table can be interpreted as a symmetric table.

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 Detail

SMTableDataObjectImpl

public SMTableDataObjectImpl()

Method Detail

addSimilarity

public void addSimilarity(AtomicObject queryObject,
                          AtomicObject caseObject,
                          double similarity)

Description copied from interface: SMTableDataObject

Adds a similarity measure for the query and case object.

Specified by:

addSimilarity in interface SMTableDataObject

Parameters:

queryObject - The query object.

caseObject - The case object.

similarity - The similarity value.

compute

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

Specified by:

compute in interface SimilarityMeasure

Returns:

getCaseObjects

public DataObjectIterator getCaseObjects(AtomicObject query)

Specified by:

getCaseObjects in interface SMTableDataObject

getQueryObjects

public DataObjectIterator getQueryObjects()

Specified by:

getQueryObjects in interface SMTableDataObject

Returns:

An iterator over all query objects for that an similarity value exists.

getSimilarity

public Similarity getSimilarity(AtomicObject queryObject,
                                AtomicObject caseObject)

Specified by:

getSimilarity in interface SMTableDataObject

Parameters:

queryObject - The query object for that the similarity value is defined.

caseObject - The case object for that the similarity value is defined.

Returns:

The similarity value for the given query and case object. If no value exists, null will be returned.

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 SMTableDataObject

Returns:

true if the similarty value table is symetric.

setSymmetric

public void setSymmetric(boolean symmetric)

Description copied from interface: SMTableDataObject

The similarity table can be interpreted as a symmetric table. That means, that in general sim(query,case) is equal to sim(case,query) if a mapping to query/case or case/query is defined. If a mapping for both is defined it will be interpreted as exception of the symetry.

Specified by:

setSymmetric in interface SMTableDataObject

Parameters:

symmetric - If the table should be interpreted as symmetric table.

removeSimilarity

public void removeSimilarity(AtomicObject queryObject,
                             AtomicObject caseObject)

Description copied from interface: SMTableDataObject

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

Specified by:

removeSimilarity in interface SMTableDataObject

Parameters:

queryObject - The query object for that the similarity value should be removed.

caseObject - The case object for that the similarity value should be removed.