/*  Copyright (C) 2003-2011 JabRef contributors.
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package net.sf.jabref.label;

import java.util.Hashtable;

import net.sf.jabref.BibtexDatabase;
import net.sf.jabref.BibtexEntry;
import net.sf.jabref.BibtexEntryType;
import net.sf.jabref.Util;


/**
 *  This class is the abstract class which contains all of the rules
 *  for making the different types of Rules.
 */
public class LabelMaker {

    public BibtexEntry applyRule(BibtexEntry newEntry, BibtexDatabase base){
	String newKey = "";
        if(ruleTable.containsKey(newEntry.getType().getName())){
            newKey = ruleTable.get(newEntry.getType().getName()).applyRule(newEntry) ;
        }
        else{
		newKey = applyDefaultRule(newEntry) ;
        }

	// Remove all illegal characters from the key.
	newKey = Util.checkLegalKey(newKey);

	// Try new keys until we get a unique one:
	if (base.setCiteKeyForEntry(newEntry.getId(), newKey)) {
	    
	    char c = 'b';
	    String modKey = newKey+"a";
	    while (base.setCiteKeyForEntry(newEntry.getId(), modKey))
		modKey = newKey+((c++));	    
	}

	//newEntry.setField(Globals.KEY_FIELD, newKey);
	// ...

		return newEntry ;
    }

    public void setDefaultRule(LabelRule newRule) {
		defaultRule = newRule ;
    }

    public String applyDefaultRule(BibtexEntry newEntry) {
        return defaultRule.applyRule(newEntry) ;
    }


    // there should be a default rule for any type
    public void addRule(LabelRule rule,BibtexEntryType type){
       ruleTable.put(type.getName(),rule) ;
    }

    protected LabelRule defaultRule = new ArticleLabelRule() ;
    protected Hashtable<String, LabelRule> ruleTable = new Hashtable<String, LabelRule>() ;

}