root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/MultilanguageTextHelper.java

/**
* Copyright (C) 2008 EDIT
* European Distributed Institute of Taxonomy 
* http://www.e-taxonomy.eu
* 
* The contents of this file are subject to the Mozilla Public License Version 1.1
* See LICENSE.TXT at the top of this package for the full license terms.
*/

package eu.etaxonomy.cdm.model.common;

import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.persistence.Transient;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlIDREF;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;

/**
 * @author a.babadshanjan
 * @created 15.09.2008
 * @version 1.0
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "MultilanguageTextHelper", propOrder = {
    "language",
    "languageString"
})
@XmlRootElement(name = "MultilanguageTextHelper")
public class MultilanguageTextHelper {

        @XmlElement(name = "Language")
    @XmlIDREF
    @XmlSchemaType(name = "IDREF")
        private Language language;
        
        @XmlElement(name = "LanguageString")
    @XmlIDREF
    @XmlSchemaType(name = "IDREF")
        private LanguageString languageString;

// TODO: Need a HashMap instead of just one pair of Language/LanguageString
//      private HashMap<Language, LanguageString> mlText;
        
        public MultilanguageTextHelper() {
        }
        
        public MultilanguageTextHelper(Language language, LanguageString languageString) {
        this.language = language;
        this.languageString = languageString;
        }
        
        @Transient
        public Language getLanguage() {
                return language;
        }
        
        public void setLanguage(Language language) {
                this.language = language;
        }

        @Transient
        public LanguageString getLanguageString() {
                return languageString;
        }
        
        public void setLanguageString(LanguageString languageString) {
                this.languageString = languageString;
        }
        
    /**
         * Returns the LanguageString in the preferred language. Preferred languages
         * are specified by the parameter languages, which receives a list of
         * Language instances in the order of preference. If no representation in
         * any preferred languages is found the method falls back to return the
         * Representation in Language.DEFAULT() and if neccesary further falls back
         * to return the first element found if any.
         * 
         * TODO think about this fall-back strategy & 
         * see also {@link TermBase#getPreferredRepresentation(List)}
         * 
         * @param languages
         * @return
         */
        public static LanguageString getPreferredLanguageString(Map<Language, LanguageString> multilanguageText, List<Language> languages) {
                
                LanguageString languageString = null;
                if(languages != null){
                        for(Language language : languages) {
                                languageString = multilanguageText.get(language);
                                if(languageString != null){
                                        return languageString;
                                }
                        }
                }
                languageString = multilanguageText.get(Language.DEFAULT());
                
                if(languageString == null && multilanguageText.size() > 0){
                        Iterator<LanguageString> it = multilanguageText.values().iterator();
                        if(it.hasNext()){
                                languageString = it.next();
                        }
                }
                return languageString;
        }
        
        /**
         * Returns a {@link Set} of {@link Language Languages} that are contained in the given multilanguage map
         * @param multilanguageText
         * @return
         */
        public static Set<Language> getLanguages(Map<Language, LanguageString> multilanguageText){
                return multilanguageText.keySet();
        }
}