Class SimilarityModelFactory
- java.lang.Object
-
- de.uni_trier.wi2.procake.similarity.SimilarityModelFactory
-
- All Implemented Interfaces:
Factory
public class SimilarityModelFactory extends Object implements Factory
This Factory class provides the implementation to theSimilarityModel
interfaces. ProCAKE contains one defaultSimilarityModel
that can be accessed viagetDefaultSimilarityModel()
.- Author:
- Rainer Maximini, Christian Zeyen
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_SIM_MODEL_NAME
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static boolean
bind(SimilarityModelFactoryObject implementation)
boolean
bind(Object implementation)
Bind an implementation to the factory.static SimilarityModel
getDefaultSimilarityModel()
The CAKE system contains one defaultSimilarityModel
that can be accessed via this method.static SimilarityModel
getSimilarityModel(String name)
static Set<String>
getSimilarityModelNames()
static Set<String>
getSimilarityModelPaths()
static Set<SimilarityModel>
getSimilarityModels()
static SimilarityModel
newSimilarityModel(String name)
This method creates a new similarity model and may overwrite an existing model with the same name.static SimilarityValuator
newSimilarityValuator()
static SimilarityValuator
newSimilarityValuator(SimilarityModel simModel)
static SimilarityValuator
newSimilarityValuatorForModel(String modelName)
void
reset()
This method has to be implemented by every factory in order to allow a proper restart of ProCAKE.static boolean
unbind(SimilarityModelFactoryObject implementation)
boolean
unbind(Object implementation)
Unbinds an implementation from the factory.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface de.uni_trier.wi2.procake.utils.composition.Factory
addParameter, postInit
-
-
-
-
Field Detail
-
DEFAULT_SIM_MODEL_NAME
public static String DEFAULT_SIM_MODEL_NAME
-
-
Method Detail
-
bind
public static boolean bind(SimilarityModelFactoryObject implementation)
-
getDefaultSimilarityModel
public static SimilarityModel getDefaultSimilarityModel()
The CAKE system contains one defaultSimilarityModel
that can be accessed via this method.- Returns:
- The default
SimilarityModel
instance.
-
getSimilarityModels
public static Set<SimilarityModel> getSimilarityModels()
- Returns:
- All available similarity models.
-
getSimilarityModelNames
public static Set<String> getSimilarityModelNames()
- Returns:
- All available similarity model names.
-
getSimilarityModelPaths
public static Set<String> getSimilarityModelPaths()
- Returns:
- The model path with the given name.
-
getSimilarityModel
public static SimilarityModel getSimilarityModel(String name)
- Parameters:
name
- similarity model name defined in composition.xml- Returns:
- The similarity model
SimilarityModel
with the given name.
-
newSimilarityModel
public static SimilarityModel newSimilarityModel(String name)
This method creates a new similarity model and may overwrite an existing model with the same name.- Parameters:
name
- The name of the new similarity model. If name equalsDEFAULT_SIM_MODEL_NAME
, the newSimilarityModel
will be the default Model. It is not possible to go back to the previous model.
-
newSimilarityValuatorForModel
public static SimilarityValuator newSimilarityValuatorForModel(String modelName)
- Returns:
- A
SimilarityValuator
instance for the model of the given nameSimilarityModel
.
-
newSimilarityValuator
public static SimilarityValuator newSimilarityValuator()
- Returns:
- A
SimilarityValuator
instance for the defaultSimilarityModel
.
-
newSimilarityValuator
public static SimilarityValuator newSimilarityValuator(SimilarityModel simModel)
- Parameters:
simModel
- TheSimilarityModel
that should be used.- Returns:
- A
SimilarityValuator
instance for the givenSimilarityModel
.
-
unbind
public static boolean unbind(SimilarityModelFactoryObject implementation)
-
reset
public void reset()
Description copied from interface:Factory
This method has to be implemented by every factory in order to allow a proper restart of ProCAKE. For example, this method might reset the default factory object or other stateful variables.
-
bind
public boolean bind(Object implementation)
Description copied from interface:Factory
Bind an implementation to the factory.- Specified by:
bind
in interfaceFactory
- Parameters:
implementation
- The object to bind.- Returns:
true
if the factory accept the implementation, otherwisefalse
.- See Also:
Factory.bind(java.lang.Object)
-
unbind
public boolean unbind(Object implementation)
Description copied from interface:Factory
Unbinds an implementation from the factory.- Specified by:
unbind
in interfaceFactory
- Parameters:
implementation
- The object to unbind.- Returns:
true
if the factory accept the implementation, otherwisefalse
.- See Also:
Factory.unbind(java.lang.Object)
-
-