package com.google.refine.clustering;

import org.json.JSONObject;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.refine.model.Project;

/**
 * Represents the configuration data for a clusterer.
 * @author Antonin Delpeuch
 *
 */
public abstract class ClustererConfig  {
    
    protected String columnName;
    
    /**
     * Reads the configuration from a JSON payload (TODO: delete)
     * @param o
     */
    public void initializeFromJSON(JSONObject o) {
        columnName = o.getString("column");
    }
    
    @JsonProperty("column")
    public String getColumnName() {
        return columnName;
    }
    
    /**
     * Instantiate the configuration on a particular project.
     * @param project
     * @return
     */
    public abstract Clusterer apply(Project project);
    
    /**
     * Type string used in Json serialization
     */
    @JsonProperty("type")
    public abstract String getType();
}