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

Class SMNESTGraphItemImpl

java.lang.Object

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

de.uni_trier.wi2.procake.similarity.nest.item.impl.SMNESTGraphItemImpl

All Implemented Interfaces:

SMNESTGraphItem, SimilarityMeasure

public class SMNESTGraphItemImpl
extends SimilarityMeasureImpl
implements SMNESTGraphItem

Implementation of measure SMNESTGraphItem.

Author:

Fabian Althoff

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.nest.item.SMNESTGraphItem

DEFAULT_REQUIRE_EQUAL_DATA_CLASS, NAME

Constructor Summary

Constructors

Constructor	Description
SMNESTGraphItemImpl()

Method Summary

Modifier and Type	Method	Description
Similarity	compute(DataObject queryObject, DataObject caseObject, SimilarityValuator valuator)
boolean	getRequireEqualDataClass()	Getter method to check whether an equal data class is required.
String	getSystemName()	The system name can be used to distinguish the similarity measures.
protected void	initialize()	This method will be called after the DataClass is set by cake.data.similarity.SimilarityMeasureImpl#compute(cake.data.objects.DataObject, de.uni_trier.wi2.procake.data.objects.DataObject) .
boolean	isSimilarityFor(DataClass dataClass, String orderName)
void	setRequireEqualDataClass(boolean requireEqualDataClass)	Setter method to control whether an equal data class is required.

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

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

SMNESTGraphItemImpl

public SMNESTGraphItemImpl()

Method Detail

setRequireEqualDataClass

public void setRequireEqualDataClass(boolean requireEqualDataClass)

Description copied from interface: SMNESTGraphItem

Setter method to control whether an equal data class is required.

Specified by:

setRequireEqualDataClass in interface SMNESTGraphItem

Parameters:

requireEqualDataClass - Boolean parameter whether an equal data class is required.

getRequireEqualDataClass

public boolean getRequireEqualDataClass()

Description copied from interface: SMNESTGraphItem

Getter method to check whether an equal data class is required.

Specified by:

getRequireEqualDataClass in interface SMNESTGraphItem

Returns:

Boolean parameter whether an equal data class is required.

compute

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

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.

isSimilarityFor

public boolean isSimilarityFor(DataClass dataClass,
                               String orderName)

Specified by:

isSimilarityFor in class SimilarityMeasureImpl

initialize

protected void initialize()

Description copied from class: SimilarityMeasureImpl

This method will be called after the DataClass is set by cake.data.similarity.SimilarityMeasureImpl#compute(cake.data.objects.DataObject, de.uni_trier.wi2.procake.data.objects.DataObject) . Override this method to initialize your SimilarityMeasure.

Overrides:

initialize in class SimilarityMeasureImpl

See Also:

SimilarityMeasure.compute(DataObject, DataObject, SimilarityValuator)