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

Interface SMCollection

All Superinterfaces:

SimilarityMeasure

All Known Subinterfaces:

SMCollectionIsolatedMapping, SMCollectionMapping, SMListCorrectness, SMListMapping, SMListMappingWeighted

All Known Implementing Classes:

SMCollectionImpl, SMCollectionIsolatedMappingImpl, SMCollectionMappingImpl, SMListCorrectnessImpl, SMListMappingImpl, SMListMappingWeightedImpl

public interface SMCollection
extends SimilarityMeasure

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOG_ATTRIBUTE_NAME_NOT_FOUND

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

LOG_ORDER_NAME_NOT_FOUND

Method Summary

Modifier and Type	Method	Description
String	getSimilarityToUse()
void	setSimilarityToUse(String newValue)	In general, the element objects of the collection are compared with their default similarity measure.

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

compute, getDataClass, getName, getSystemName, isForceOverride, isReusable, setForceOverride

Field Details

LOG_ATTRIBUTE_NAME_NOT_FOUND

static final String LOG_ATTRIBUTE_NAME_NOT_FOUND

See Also:

• Constant Field Values

Method Details

getSimilarityToUse

String getSimilarityToUse()

Returns:

The defined name of the SimilarityMeasure that should be used for the elements.

See Also:

• setSimilarityToUse(String)

setSimilarityToUse

void setSimilarityToUse(String newValue)

In general, the element objects of the collection are compared with their default similarity measure. But in some situations it can be necessary to use another similarity measure for the elements of a collection. Therefore, it exists the possibility to specify a similarity measure name that should be used instead. For each DataObject a similarity measure with that name should exist. Otherwise, the comparision of objects are ignored.

Summarizing:

• If the newValue is null the default measures of the objects are used. This is the default behaviour.
• If the newValue is the name of a similarity measure, for each data class whose objects can be occured in the collection a similarity measure with this name must exist. Attention, this also include the common super classes of the objects.

Parameters:

newValue - The name of the similarity measure that should be used for the elements.