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

Class SimilarityModelImpl

java.lang.Object

de.uni_trier.wi2.procake.similarity.impl.SimilarityModelImpl

All Implemented Interfaces:

SimilarityModel

public class SimilarityModelImpl
extends Object
implements SimilarityModel

Author:

Rainer Maximini

Field Summary

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

COMPONENT, COMPONENT_KEY, LOG_CREATING_NEW_MEASURE_FAILED, LOG_INITIALIZATION_FAILED, LOG_NO_MODEL_READER_FOUND, LOG_READING_INITIAL_MODEL_FAILED, LOG_SIMILARITY_NAME_ALREADY_EXISTS, LOG_SIMILARITY_NAME_NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
SimilarityModelImpl()

Method Summary

Modifier and Type	Method	Description
void	addParameter(String name, String value)	Adds the given name and value to the similarity parameter list.
void	addSimilarityMeasure(SimilarityMeasure measure, String name)	Newly created SimilarityMeasures are not registered automatically.
SimilarityMeasure	createAndRegisterSimilarityMeasure(String uniqueName, String measureTemplateName, DataClass dataClass)	Creates a new SimilarityMeasure and registers
SimilarityMeasure	createSimilarityMeasure(String name, DataClass dataClass)	Creates a new SimilarityMeasure that is not automatically registered.
Map<String,String>	getAllParameters()	Returns a complete list of all parameters in the system.
String	getParameter(String name)	The value with the given parameter name will be returned.
String[]	getPossibleSimilarityMeasureFor(DataClass dataClass)	Computes all similarity measure that are possible for the given data class without any order.
String[]	getPossibleSimilarityMeasureFor(DataClass dataClass, String orderName)	Computes all similarity measure that are possible for the given data class / order combination.
SimilarityMeasure	getSimilarityMeasure(DataClass dataClass)	Returns a suitable similarity measure for the given data class.
SimilarityMeasure	getSimilarityMeasure(DataClass dataClass, String name)
List<SimilarityMeasure>	getSimilarityMeasures()
SimilarityMeasure[]	getSimilarityMeasures(DataClass dataClass)	Retrieves all registered SimilarityMeasures for the given DataClass.
String[]	getSimilarityNamesFor(DataClass dataClass)
boolean	isDefaultSimilarityMeasure(SimilarityMeasure similarityMeasure)
void	overwriteMatchingDataClasses(Model oldModel)	Checks for each measure if it contains a DataClass reference that is present in the given 'other' Model.
void	registerSimilarityMeasureTemplate(SimilarityMeasure measure)	Add the similarity measure passed to the similarityMeasureTemplateCache.
void	removeParameter(String name)	The parameter with the given name will be removed from the internal parameter-list
SimilarityMeasure	removeSimilarityMeasure(DataClass dataClass, String name)	Removes the similarity measure with the given name for the given data class.
SimilarityMeasure	removeSimilarityMeasure(SimilarityMeasure sm)	Removes the given similarity measure.
SimilarityMeasure	renameSimilarityMeasure(DataClass dataClass, String oldName, String newName)	Renames an already registered SimilarityMeasure.
void	setDefaultSimilarityMeasure(DataClass dataClass, String measureName)	The Retriever uses in general the default SimilarityMeasure that can be defined with this method.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimilarityModelImpl

public SimilarityModelImpl()

Method Detail

createAndRegisterSimilarityMeasure

public SimilarityMeasure createAndRegisterSimilarityMeasure(String uniqueName,
                                                            String measureTemplateName,
                                                            DataClass dataClass)
                                                     throws NameAlreadyExistsException

Description copied from interface: SimilarityModel

Creates a new SimilarityMeasure and registers

Specified by:

createAndRegisterSimilarityMeasure in interface SimilarityModel

Parameters:

uniqueName - a new unique name to identify the new measure

measureTemplateName - Each similarity measure contains a static field "NAME" that contains the name of the similarity measure, e.g., SMAggregateAverage.NAME. If this field does not exists, the similarity measure can not be instantiated.

dataClass - The DataClass for that the similarity measure should be created.

Returns:

The new SimilarityMeasure or null if the name does not relate to a similarity * measure or the similarity measure does not fit to the data class

Throws:

NameAlreadyExistsException - is thrown if the given name is already defined for the data class.

overwriteMatchingDataClasses

public void overwriteMatchingDataClasses(Model oldModel)

Description copied from interface: SimilarityModel

Checks for each measure if it contains a DataClass reference that is present in the given 'other' Model. If so, it replaces that reference.

Specified by:

overwriteMatchingDataClasses in interface SimilarityModel

Parameters:

oldModel - The Model whose dataclasses should be referenced

addSimilarityMeasure

public void addSimilarityMeasure(SimilarityMeasure measure,
                                 String name)
                          throws NameAlreadyExistsException

Description copied from interface: SimilarityModel

Newly created SimilarityMeasures are not registered automatically. This must be done in this method whereby each SimilarityMeasure an unique name for this dataClass is defined. The corresponding DataClassis already defined in the similarity measure.

Specified by:

addSimilarityMeasure in interface SimilarityModel

Parameters:

measure - the new similarity measure

name - a new unique name

Throws:

NameAlreadyExistsException - is thrown if the given name is already defined for the data class.

createSimilarityMeasure

public SimilarityMeasure createSimilarityMeasure(String name,
                                                 DataClass dataClass)

Description copied from interface: SimilarityModel

Creates a new SimilarityMeasure that is not automatically registered. The registration must be done with the SimilarityModel.addSimilarityMeasure(SimilarityMeasure, String) method.

Specified by:

createSimilarityMeasure in interface SimilarityModel

Parameters:

name - Each similarity measure contains a static field "NAME" that contains the name of the similarity measure, e.g., SMAggregateAverage.NAME. If this field does not exists, the similarity measure can not be instantiated.

dataClass - The DataClass for that the similarity measure should be created.

Returns:

The new SimilarityMeasure or null if the name does not relate to a similarity measure or the similarity measure does not fit to the data class

registerSimilarityMeasureTemplate

public void registerSimilarityMeasureTemplate(SimilarityMeasure measure)
                                       throws NameAlreadyExistsException

Add the similarity measure passed to the similarityMeasureTemplateCache. After this model has been initialized, the latter is populated with template objects for each of the standard measures available. Call this method to register an application-specific template.

Specified by:

registerSimilarityMeasureTemplate in interface SimilarityModel

Throws:

NameAlreadyExistsException

See Also:

SimilarityModel.registerSimilarityMeasureTemplate(SimilarityMeasure)

getSimilarityMeasures

public List<SimilarityMeasure> getSimilarityMeasures()

Specified by:

getSimilarityMeasures in interface SimilarityModel

Returns:

all available similarity measures also including system similarity measures

isDefaultSimilarityMeasure

public boolean isDefaultSimilarityMeasure(SimilarityMeasure similarityMeasure)

Specified by:

isDefaultSimilarityMeasure in interface SimilarityModel

Parameters:

similarityMeasure - The similarity measure

Returns:

Returns true, if given measure is defined as default.

getSimilarityMeasure

public SimilarityMeasure getSimilarityMeasure(DataClass dataClass)

Description copied from interface: SimilarityModel

Returns a suitable similarity measure for the given data class. Default measures are preferred over other suitable measures.

Specified by:

getSimilarityMeasure in interface SimilarityModel

Parameters:

dataClass - The data class for that a suitable SimilarityMeasure should be retrieved.

Returns:

A SimilarityMeasure for the given data class.

getPossibleSimilarityMeasureFor

public String[] getPossibleSimilarityMeasureFor(DataClass dataClass)

Description copied from interface: SimilarityModel

Computes all similarity measure that are possible for the given data class without any order.

Specified by:

getPossibleSimilarityMeasureFor in interface SimilarityModel

Parameters:

dataClass - The data class for that the available SimilarityMeasures should be retrieved.

Returns:

An array of available SimilarityMeasure names for the given data class.

getPossibleSimilarityMeasureFor

public String[] getPossibleSimilarityMeasureFor(DataClass dataClass,
                                                String orderName)

Description copied from interface: SimilarityModel

Computes all similarity measure that are possible for the given data class / order combination. This does not includes similarity measures that are also possible without the order.

Specified by:

getPossibleSimilarityMeasureFor in interface SimilarityModel

Parameters:

dataClass - The data class for that the available SimilarityMeasures should be retrieved.

orderName - The name of the similarity that should be used.

Returns:

An array of SimilarityMeasure names for the given data class and order.

getSimilarityMeasure

public SimilarityMeasure getSimilarityMeasure(DataClass dataClass,
                                              String name)

Specified by:

getSimilarityMeasure in interface SimilarityModel

Parameters:

dataClass - The data class for which the available SimilarityMeasures should be retrieved.

name - The name of the similarity that should be used.

Returns:

The specified SimilarityMeasure

getSimilarityMeasures

public SimilarityMeasure[] getSimilarityMeasures(DataClass dataClass)

Description copied from interface: SimilarityModel

Retrieves all registered SimilarityMeasures for the given DataClass.

Specified by:

getSimilarityMeasures in interface SimilarityModel

Parameters:

dataClass - The data class for that the registered SimilarityMeasures should be retrieved.

Returns:

An array of registered SimilarityMeasures for the given data class. If dataClass is null an empty array will be returned.

getSimilarityNamesFor

public String[] getSimilarityNamesFor(DataClass dataClass)

Specified by:

getSimilarityNamesFor in interface SimilarityModel

Parameters:

dataClass - The data class for that the registered SimilarityMeasure names should be retrieved.

Returns:

An array of names of the registered SimilarityMeasures for the given data class.

removeSimilarityMeasure

public SimilarityMeasure removeSimilarityMeasure(DataClass dataClass,
                                                 String name)

Description copied from interface: SimilarityModel

Removes the similarity measure with the given name for the given data class.

Specified by:

removeSimilarityMeasure in interface SimilarityModel

Parameters:

dataClass - The data class whos similarity measure should be removed.

name - The name of the similarity measure that should be removed.

Returns:

The removed similarity measure or null if the measure was not found.

removeSimilarityMeasure

public SimilarityMeasure removeSimilarityMeasure(SimilarityMeasure sm)

Description copied from interface: SimilarityModel

Removes the given similarity measure.

Specified by:

removeSimilarityMeasure in interface SimilarityModel

Parameters:

sm - The similarity measure that should be removed;

Returns:

The removed similarity measure or null if the measure was not found.

renameSimilarityMeasure

public SimilarityMeasure renameSimilarityMeasure(DataClass dataClass,
                                                 String oldName,
                                                 String newName)
                                          throws NameAlreadyExistsException,
                                                 NameNotFoundException

Description copied from interface: SimilarityModel

Renames an already registered SimilarityMeasure. If the default SimilarityMeasure is effected, the default one will be renamed too.

Specified by:

renameSimilarityMeasure in interface SimilarityModel

Parameters:

dataClass - The data clas for that the similiarity measure should be renamed

oldName - the old similarity measure name

newName - the new similarity measure name

Returns:

the renamed similarity measure

Throws:

NameAlreadyExistsException - is thrown if the new name already exists for the data class

NameNotFoundException - is thrown if now similarity with the old name for the data class can be found.

setDefaultSimilarityMeasure

public void setDefaultSimilarityMeasure(DataClass dataClass,
                                        String measureName)
                                 throws NameNotFoundException

Description copied from interface: SimilarityModel

The Retriever uses in general the default SimilarityMeasure that can be defined with this method. Therefore the data class and the similarity measure name must be defined.

Specified by:

setDefaultSimilarityMeasure in interface SimilarityModel

Parameters:

dataClass - The DataClass for that the default SimilarityMeasure should be defined.

measureName - The name of the SimilarityMeasure.

Throws:

NameNotFoundException

addParameter

public void addParameter(String name,
                         String value)

Description copied from interface: SimilarityModel

Adds the given name and value to the similarity parameter list. If the name is already used, the previous value will be overwritten with the given value.

Specified by:

addParameter in interface SimilarityModel

Parameters:

name - The name of the parameter

value - The value of the parameter

removeParameter

public void removeParameter(String name)

Description copied from interface: SimilarityModel

The parameter with the given name will be removed from the internal parameter-list

Specified by:

removeParameter in interface SimilarityModel

getParameter

public String getParameter(String name)

Description copied from interface: SimilarityModel

The value with the given parameter name will be returned.

Specified by:

getParameter in interface SimilarityModel

Returns:

The requested value

getAllParameters

public Map<String,String> getAllParameters()

Description copied from interface: SimilarityModel

Returns a complete list of all parameters in the system. This is a copy of the internal map, so modifications to this map do not harm the internal map.

Specified by:

getAllParameters in interface SimilarityModel

Returns: