LabelFactory - internationalisierte Beschriftungen aus der Datenbank

Als Entwickler von Benutzerinterfaces hat man oft das Problem, dass Bedienelemente beschriftet werden müssen - je nach Projekt auch mehrsprachig. Üblicherweise wird dieses mit Ressourcefiles erledigt, die zusätzlich zum Code gewartet und verwaltet werden müssen. Meine LabelFactory generiert Label und Tooltiptext Vorbelegungen direkt aus dem Java Code in die Datenbank.

Ich bevorzuge es, meine Benutzeroberflächen direkt in Java zu programmieren und entsprechend muß ich dann dort schon die Beschriftung organisieren. In der Klasse, die mein Bedienelement generiert instanziere ich eine LabelFactory mit:

public class MyGUIComponent { LabelFactory lf = new LabelFactory(this.getClass()); ...

um sie dann z.B. so zu benutzen:

Button saveButton = new Button(lf.label("saveButton", "Save", "Save data of this form")); saveButton.setTooltiptext(lf.tooltiptext("saveButton")) ; Button deleteButton = new Button(lf.label("deleteButton", "Delete", "Delete this DB entry")); saveButton.setTooltiptext(lf.tooltiptext("saveButton")) ;

Der erste lf.label(String key, String initlabel, String inittooltip) Aufruf sucht z.b. bei locale "de" den Key "de:MyGUIComponent.saveButton" - zuerst im Label Cache, dann in der Datenbank. Liegen noch keine Einträge vor, werden sie neu angelegt. In der Datenbank finden sich dann folgende neue Einträge:


Key (PK)	Label	Tooltiptext


de:MyGUIComponent.saveButton	!Save	!Save data of this form
de:MyGUIComponent.deleteButton	!Delete	!Delete this DB entry;

Das Ausrufezeichen signalisiert, dass dieser Label noch mit den englischen Defaulttexten des Programmierers versehen ist und noch übersetzt werden muß. (Diese Ausrufezeichen sind Ihnen vieleicht schon beim Anmeldeformular begegnet).

LabelFactory.java

package net.empego.zk.util;

import javax.servlet.http.HttpServletRequest;

import org.hibernate.Session;
import org.zkoss.zk.ui.Executions;
import net.empego.core.hbm.I18nLabel;
import net.empego.core.util.HibUtil;



/**
 * @author Thomas Mueller - empego.net
 * Provide i18n labels from Cache (TODO) and/or DB table i18n_label
 * 
 * Key naming: "locale:prefix:MyLabelKey", e.g.: "de:EcBoxI18nEditor:actions
 * 
 * usage: 
 * CacheLabelFactory lf = new CacheLabelFactory(this.class);
 * i18nLabel = lf.label("MyLabelkey");
 * 
 * TODO: Cache labels!
 */

public class LabelFactory {
	String locale;
	String prefix;
	
	boolean learnMode = Boolean.parseBoolean(CFG.get("I18N_LEARN_MODE", "true"));
	
	/**
	 * Label domain from Class.getSimpleName
	 * @param labelDomain
	 */
	public LabelFactory(Class labelDomain) {
		super();
		
		this.prefix = labelDomain.getSimpleName();
		
		this.locale = ((HttpServletRequest) Executions.getCurrent()
				.getNativeRequest()).getLocale().getLanguage();
	}
	
	
	/**
	 * self created Label domain
	 * @param prefix
	 */
	public LabelFactory(String prefix) {
		super();
		
		this.prefix = prefix;
		
		this.locale = ((HttpServletRequest) Executions.getCurrent()
				.getNativeRequest()).getLocale().getLanguage();
	}
	
	/**
	 * LabelFactory without key prefix
	 */
	public LabelFactory() {
		super();
		
		this.prefix = "";
		
		this.locale = ((HttpServletRequest) Executions.getCurrent()
				.getNativeRequest()).getLocale().getLanguage();
	}
	
	/**
	 * creates label entries in DB
	 * @param key
	 * @param defaultLabel
	 * @param defaulttooltip
	 * @return
	 */
	private I18nLabel learn(String key, String defaultLabel, String defaulttooltip){
		I18nLabel i18nLabel = new I18nLabel();
		i18nLabel.setLabelKey(locale + ":" + prefix + ":" + key);
		i18nLabel.setLabel(defaultLabel == null? "!" + key: "!" + defaultLabel);
		i18nLabel.setTooltiptext(defaulttooltip == null? "!" + locale + ":" + prefix + ":" + key
				+ " Translation not yet available... sorry!" : "!" + defaulttooltip);
		i18nLabel.setOrder((short)0);
		
		Session hs = HibUtil.currentSession();
		hs.save(i18nLabel);
		
		return i18nLabel;
	}
	
	/**
	 * create basic label entries in DB
	 * @param key
	 * @param defaultLabel
	 * @param defaulttooltip
	 * @return
	 */
	private I18nLabel learnBasic(String key, String defaultLabel, String defaulttooltip){
		I18nLabel i18nLabel = new I18nLabel();
		i18nLabel.setLabelKey(locale + ":" + key);
		i18nLabel.setLabel(defaultLabel == null? "!" + key: "!" + defaultLabel);
		i18nLabel.setTooltiptext(defaulttooltip == null? "!" + locale + ":" + key
				+ " Translation not yet available... sorry!" : "!" + defaulttooltip);
		i18nLabel.setOrder((short)0);
		
		Session hs = HibUtil.currentSession();
		hs.save(i18nLabel);
		
		return i18nLabel;
	}
	

	
	/**
	 * @param i18nKey
	 * @return a label for the i18nkey
	 */
	public String label(String i18nKey){
		return label(i18nKey, null, null);
	}
	
	/**
	 * return a label for the i18nkey with default values
	 * @param i18nKey
	 * @param defaultLabel
	 * @param defaulttooltip
	 * @return a label for the i18nkey
	 */
	public String label(String i18nKey, String defaultLabel, String defaulttooltip){
		//TODO: retrieve from cache
		Session hs = HibUtil.currentSession();
		I18nLabel i18nLabel = (I18nLabel)hs.get(I18nLabel.class, locale + ":" + prefix + ":" +i18nKey);
		if(i18nLabel == null){
			if(learnMode){
				return learn(i18nKey, defaultLabel, defaulttooltip).getLabel();
			}
			return "*" + i18nKey;
		}
		if((i18nLabel.getLabel()==null) || (i18nLabel.getLabel().equals(""))){
			return "!" + i18nKey;
		}
		
		return i18nLabel.getLabel();
	}
	
	/**
	 * return a basic label for the i18nkey. Basic labels use no prefix and are for 
	 * common and often used labels. (e.g. to avoid multple "Save" labels)
	 * @param i18nKey
	 * @return a basic label for the i18nkey
	 */
	public String basicLabel(String i18nKey){
		return basicLabel(i18nKey, null, null);
	}
	
	public String basicLabel(String i18nKey, String defaultLabel, String defaulttooltip){
		//TODO: retrieve from cache
		Session hs = HibUtil.currentSession();
		I18nLabel i18nLabel = (I18nLabel)hs.get(I18nLabel.class, locale + ":" +i18nKey);
		if(i18nLabel == null){
			if(learnMode){
				return learnBasic(i18nKey, defaultLabel, defaulttooltip).getLabel();
			}
			return "*" + i18nKey;
		}
		if((i18nLabel.getLabel()==null) || (i18nLabel.getLabel().equals(""))){
			return "*" + locale + ":" + i18nKey;
		}
		
		return i18nLabel.getLabel();
	}

	public String tooltiptext(String i18nKey){
		return tooltiptext(i18nKey, null, null);
	}

	
	public String tooltiptext(String i18nKey, String defaultLabel, String defaulttooltip){
		//TODO: retrieve from cache
		Session hs = HibUtil.currentSession();
		I18nLabel i18nLabel = (I18nLabel)hs.get(I18nLabel.class, locale + ":" + prefix + ":" +i18nKey);
		if(i18nLabel == null){
			if(learnMode){
				return learn(i18nKey, defaultLabel, defaulttooltip).getTooltiptext();
			}
			return "*" + locale + ":" + prefix + ":" + i18nKey;
		}

		if((i18nLabel.getTooltiptext()==null) || (i18nLabel.getTooltiptext().equals(""))){
			return "*" + locale + ":" + prefix + ":" +i18nKey;
		}
		
		return i18nLabel.getTooltiptext();
	}

	public String basicTooltiptext(String i18nKey){
		return basicTooltiptext(i18nKey, null, null);
	}

	public String basicTooltiptext(String i18nKey, String defaultLabel, String defaulttooltip){
		//TODO: retrieve from cache
		Session hs = HibUtil.currentSession();
		I18nLabel i18nLabel = (I18nLabel)hs.get(I18nLabel.class, locale + ":" +i18nKey);
		if(i18nLabel == null){
			if(learnMode){
				return learnBasic(i18nKey, defaultLabel, defaulttooltip).getTooltiptext();
			}
			return "!" + locale + ":" +i18nKey;
		}

		if((i18nLabel.getTooltiptext()==null) || (i18nLabel.getTooltiptext().equals(""))){
			return "!" + locale + ":" +i18nKey;
		}
		
		return i18nLabel.getTooltiptext();
	}
	
	public int order(String i18nKey){
		//TODO: retrieve from cache
		Session hs = HibUtil.currentSession();
		I18nLabel i18nLabel = (I18nLabel)hs.get(I18nLabel.class, locale + ":" + prefix + ":" +i18nKey);
		if(i18nLabel == null){
			return 0;
		}
		if((i18nLabel.getLabel()==null) || (i18nLabel.getLabel().equals(""))){
			return 0;
		}
		
		return i18nLabel.getOrder();
	}

	public String getLocale() {
		return locale;
	}

	public void setLocale(String locale) {
		this.locale = locale;
	}
}