es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.NNConfig Maven / Gradle / Ivy

Go to download
/**
 * NNConfig.java
 * jCOLIBRI2 framework. 
 * @author Juan A. Recio-Garc�a.
 * GAIA - Group for Artificial Intelligence Applications
 * http://gaia.fdi.ucm.es
 * 03/01/2007
 */
package es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval;


import java.util.HashMap;

import es.ucm.fdi.gaia.jcolibri.cbrcore.Attribute;
import es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.similarity.GlobalSimilarityFunction;
import es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.similarity.LocalSimilarityFunction;

/**
 * This class stores the configuration for the NN retrieval method.
 * It stores:
 * 
 * The global similarity function for the description.
 * 
Global similarity functions for each compound attribute (CaseComponents excepting the description).
 * 
Local similairity functions for each simple attribute.
 * 
Weight for each attribute. (1 by default)
 * 
 * @author Juan A. Recio-Garcia
 * @version 1.0
 */
public class NNConfig{
		
	private HashMap maplocal = new HashMap<>();
	private HashMap mapglobal = new HashMap<>();
	private HashMap mapweight = new HashMap<>();
	
	private GlobalSimilarityFunction descriptionSimFunction;
	

	public NNConfig()
	{
	}

	/**
	 * @return Returns the description similarity function.
	 */
	public GlobalSimilarityFunction getDescriptionSimFunction() {
		return descriptionSimFunction;
	}
	/**
	 * @param descriptionSimFunction The description similarity function. to set.
	 */
	public void setDescriptionSimFunction(GlobalSimilarityFunction descriptionSimFunction) {
		this.descriptionSimFunction = descriptionSimFunction;
	}

	/**
	 * Sets the local similarity function to apply to a simple attribute.
	 */
	public void addMapping(Attribute attribute, LocalSimilarityFunction similFunction)
	{
		maplocal.put(attribute, similFunction);
	}
	
	/**
	 * Gets the local similarity function configured for a given simple attribute.
	 */
	public LocalSimilarityFunction getLocalSimilFunction(Attribute attribute)
	{
		return maplocal.get(attribute);
	}
	
	/**
	 * Sets the global similarity function to apply to a compound attribute.
	 */
	public void addMapping(Attribute attribute, GlobalSimilarityFunction similFunction)
	{
		mapglobal.put(attribute, similFunction);
	}
	
	/**
	 * Gets the global similarity function configured for a given compound attribute.
	 */
	public GlobalSimilarityFunction getGlobalSimilFunction(Attribute attribute)
	{
		return mapglobal.get(attribute);
	}
	
	/**
	 * Sets the weight for an attribute.
	 */
	public void setWeight(Attribute attribute, Double weight)
	{
		mapweight.put(attribute, weight);
	}
	
	/**
	 * Gets the weight for an attribute. If an attribute does not have a configured weight it returns 1 by default.
	 */
	public Double getWeight(Attribute attribute)
	{
		Double d = mapweight.get(attribute);
		if(d!= null)
			return d;
		else
			return new Double(1); 
	}
}