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

Class SMCollectionImpl

java.lang.Object

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

de.uni_trier.wi2.procake.similarity.base.collection.impl.SMCollectionImpl

All Implemented Interfaces:

SMCollection, SimilarityMeasure

Direct Known Subclasses:

SMCollectionIsolatedMappingImpl, SMCollectionMappingImpl, SMListCorrectnessImpl, SMListMappingImpl

public abstract class SMCollectionImpl
extends SimilarityMeasureImpl
implements SMCollection

Field Summary

Fields

Modifier and Type	Field	Description
protected String	similarityToUse

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.collection.SMCollection

LOG_ATTRIBUTE_NAME_NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
SMCollectionImpl()

Method Summary

Modifier and Type	Method	Description
protected Similarity	checkStoppingCriteria(DataObject queryObject, DataObject caseObject)
protected CollectionClass	getCollectionClass()
String	getSimilarityToUse()
protected void	initializeBasedOn(SimilarityMeasure base)	Initialize measure based on existing instance
boolean	isSimilarityFor(DataClass dataclass, String orderName)
void	setSimilarityToUse(String newValue)	In general, the element objects of the collection are compared with their default similarity measure.

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

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

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

Field Detail

similarityToUse

protected String similarityToUse

Constructor Detail

SMCollectionImpl

public SMCollectionImpl()

Method Detail

getSimilarityToUse

public String getSimilarityToUse()

Specified by:

getSimilarityToUse in interface SMCollection

Returns:

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

See Also:

SMCollection.setSimilarityToUse(String)

setSimilarityToUse

public void setSimilarityToUse(String newValue)

Description copied from interface: SMCollection

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.

Specified by:

setSimilarityToUse in interface SMCollection

Parameters:

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

isSimilarityFor

public boolean isSimilarityFor(DataClass dataclass,
                               String orderName)

Specified by:

isSimilarityFor in class SimilarityMeasureImpl

getCollectionClass

protected CollectionClass getCollectionClass()

checkStoppingCriteria

protected Similarity checkStoppingCriteria(DataObject queryObject,
                                           DataObject caseObject)

initializeBasedOn

protected void initializeBasedOn(SimilarityMeasure base)

Description copied from class: SimilarityMeasureImpl

Initialize measure based on existing instance

Overrides:

initializeBasedOn in class SimilarityMeasureImpl

Parameters:

base - similarity measure to base on