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

Class DependencySimilarityImpl

java.lang.Object

de.uni_trier.wi2.procake.similarity.impl.SimilarityImpl

de.uni_trier.wi2.procake.similarity.impl.DependencySimilarityImpl

All Implemented Interfaces:

DependencySimilarity, Similarity, Comparable<Similarity>

public class DependencySimilarityImpl
extends SimilarityImpl
implements DependencySimilarity

Implementation of DependencySimilarity.

Author:

Rahol Kumar, Alexander Schultheis

Field Summary

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

VALUE_INVALID

Constructor Summary

Constructors

Constructor	Description
DependencySimilarityImpl(SimilarityMeasure similarityMeasure, List<DataObject> queryObjects, List<DataObject> caseObjects, double alpha)

Method Summary

Modifier and Type	Method	Description
void	addCaseObject(DataObject caseObject)	Method, that adds a case objects to the similarity.
void	addQueryObject(DataObject queryObject)	Method, that adds a query objects to the similarity.
void	addSimilarity(DataObject queryObject, DataObject caseObject, Similarity similarity)	Method, that adds a similarity between two data objects.
void	addSimilarity(Similarity similarity)	Method, that adds a similarity between one query and one case object to the dependency similarity.
DataObject	getCaseObject()
List<DataObject>	getCaseObjects()	Method, that returns all case objects of the similarity.
DataObject	getQueryObject()
List<DataObject>	getQueryObjects()	Method, that returns all query objects of the similarity.
Similarity	getSingleCaseObjectSimilarity(DataObject caseObject)	Method, that returns a single similarity for a case object.
double	getValue()	Computes average similarity value
boolean	isValidValue()	Checks, if every similarity is a valid value
void	setCaseObject(DataObject caseObject)
void	setDependencySimilarityWeight(double dependencySimilarityWeight)	Method, that sets the weight for the dependency similarity.
void	setQueryObject(DataObject queryObject)
void	setValue(double value)
String	toDetailedString()

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

compareTo, filterLocalSimilarities, getInfo, getLocalSimilarities, getSimilarityMeasure, hashCode, hasSameValueAsIn, hasSameValueAsIn, isLessThan, pruneLocalSimilarities, removeLocalSimilaritiesWithNullMapping, setInfo, setInvalidValue, setLocalSimilarities, setSimilarityMeasure, sortLocalSimilarities, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

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

filterLocalSimilarities, getInfo, getLocalSimilarities, getSimilarityMeasure, hasSameValueAsIn, isLessThan, pruneLocalSimilarities, removeLocalSimilaritiesWithNullMapping, sortLocalSimilarities

Constructor Detail

DependencySimilarityImpl

public DependencySimilarityImpl(SimilarityMeasure similarityMeasure,
                                List<DataObject> queryObjects,
                                List<DataObject> caseObjects,
                                double alpha)

Method Detail

getQueryObjects

public List<DataObject> getQueryObjects()

Description copied from interface: DependencySimilarity

Method, that returns all query objects of the similarity.

Specified by:

getQueryObjects in interface DependencySimilarity

Returns:

A list of all query objects.

getCaseObjects

public List<DataObject> getCaseObjects()

Description copied from interface: DependencySimilarity

Method, that returns all case objects of the similarity.

Specified by:

getCaseObjects in interface DependencySimilarity

Returns:

A list of all case objects.

addQueryObject

public void addQueryObject(DataObject queryObject)

Description copied from interface: DependencySimilarity

Method, that adds a query objects to the similarity. Note that in the norm case it's better to store query and case directly with the similarity through the DependencySimilarity.addSimilarity(DataObject, DataObject, Similarity) method.

Specified by:

addQueryObject in interface DependencySimilarity

Parameters:

queryObject - The query object to be added.

addCaseObject

public void addCaseObject(DataObject caseObject)

Description copied from interface: DependencySimilarity

Method, that adds a case objects to the similarity. Note that in the norm case it's better to store query and case directly with the similarity through the DependencySimilarity.addSimilarity(DataObject, DataObject, Similarity) method.

Specified by:

addCaseObject in interface DependencySimilarity

Parameters:

caseObject - The case object to be added.

addSimilarity

public void addSimilarity(Similarity similarity)

Description copied from interface: DependencySimilarity

Method, that adds a similarity between one query and one case object to the dependency similarity. Note that in the norm case it's better to store query and case directly with the similarity through the DependencySimilarity.addSimilarity(DataObject, DataObject, Similarity) method.

Specified by:

addSimilarity in interface DependencySimilarity

Parameters:

similarity - The similarity to be added.

getQueryObject

public DataObject getQueryObject()

Specified by:

getQueryObject in interface Similarity

Overrides:

getQueryObject in class SimilarityImpl

Returns:

query element

setQueryObject

public void setQueryObject(DataObject queryObject)

Overrides:

setQueryObject in class SimilarityImpl

getCaseObject

public DataObject getCaseObject()

Specified by:

getCaseObject in interface Similarity

Overrides:

getCaseObject in class SimilarityImpl

Returns:

case element

setCaseObject

public void setCaseObject(DataObject caseObject)

Overrides:

setCaseObject in class SimilarityImpl

setDependencySimilarityWeight

public void setDependencySimilarityWeight(double dependencySimilarityWeight)

Description copied from interface: DependencySimilarity

Method, that sets the weight for the dependency similarity. This value is set if the combined case is not a full match, but the combined case has similar dependencies.

Specified by:

setDependencySimilarityWeight in interface DependencySimilarity

Parameters:

dependencySimilarityWeight - Weight for the dependency. If not set, this weight is 1.0.

getValue

public double getValue()

Description copied from interface: DependencySimilarity

Computes average similarity value

Specified by:

getValue in interface DependencySimilarity

Specified by:

getValue in interface Similarity

Overrides:

getValue in class SimilarityImpl

Returns:

a double value between 0 and 1

addSimilarity

public void addSimilarity(DataObject queryObject,
                          DataObject caseObject,
                          Similarity similarity)

Description copied from interface: DependencySimilarity

Method, that adds a similarity between two data objects.

Specified by:

addSimilarity in interface DependencySimilarity

Parameters:

queryObject - The query object.

caseObject - The case object.

similarity - The similarity between query and case object.

setValue

public void setValue(double value)

Overrides:

setValue in class SimilarityImpl

isValidValue

public boolean isValidValue()

Description copied from interface: DependencySimilarity

Checks, if every similarity is a valid value

Specified by:

isValidValue in interface DependencySimilarity

Specified by:

isValidValue in interface Similarity

Overrides:

isValidValue in class SimilarityImpl

Returns:

true if the computation was successful and a correct value between 0 and 1 will be returned by getValue()

getSingleCaseObjectSimilarity

public Similarity getSingleCaseObjectSimilarity(DataObject caseObject)

Description copied from interface: DependencySimilarity

Method, that returns a single similarity for a case object.

Specified by:

getSingleCaseObjectSimilarity in interface DependencySimilarity

Parameters:

caseObject - The case object, the similarity for is desired.

Returns:

Similarity between given case object and query object at the same position.

toDetailedString

public String toDetailedString()

Specified by:

toDetailedString in interface Similarity

Overrides:

toDetailedString in class SimilarityImpl

Returns:

detailed string representation