ResourceTranslator.java

/*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
* 
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
* License for the specific language governing rights and limitations under
* the License.
* 
* The Original Code is OpenELIS code.
* 
* Copyright (C) The Minnesota Department of Health.  All Rights Reserved.
*
* Contributor(s): CIRG, University of Washington, Seattle WA.
*/
package us.mn.state.health.lims.reports.action.implementation.reportBeans;

import java.util.*;

import us.mn.state.health.lims.common.valueholder.BaseObject;
import us.mn.state.health.lims.common.valueholder.SimpleBaseEntity;
import us.mn.state.health.lims.dictionary.daoimpl.DictionaryDAOImpl;
import us.mn.state.health.lims.dictionary.valueholder.Dictionary;
import us.mn.state.health.lims.gender.daoimpl.GenderDAOImpl;
import us.mn.state.health.lims.gender.valueholder.Gender;

/**
 * RetroCI wants CSV export to list the numeric values that are prefixed on the message resources.
 * We use these classes to go from a DB ID (or other column defined by getKey) to the resource and peel off the value at the front of the localized resource string.
 * @author Paul A. Hill (pahill@uw.edu)
 * @since Feb 1, 2011
 */
public class ResourceTranslator<T extends BaseObject> {
    /**
     * placed on values that are not actually translated
     */
    public static final String NOT_FOUND_TAG = "%%";
    protected Map<String, T> map = new HashMap<String, T>();

    /**
     * 
     */
    public ResourceTranslator(List<T> ts) {
        for (T t : ts) {
            map.put(getKey(t), t);
        }
    }
    
    /**
     * What part of the entity is used to lookup the record to find the localized name?
     * @param some object
     * @return some value of some field in that object, typicaly the ID.
     */
    @SuppressWarnings("unchecked")
    protected String getKey(T t) {
        return ((SimpleBaseEntity<String>)t).getId();
    }
    
    /**
     * if it is not found in the translator, just return the original value.
     */
    public String translateOrNot(String original) {
        String translation = translate(original);
        if (translation.startsWith(NOT_FOUND_TAG)) {
            return original;
        } else {
            return translation;
        }
    }

    /**
     * This implements what CI was looking for.  Get the localized string, and if it starts with a number just show that.
     * @param id
     * @return
     */
    public String translate(String id) {
        String resource = translateRaw(id);
        int dash = resource.indexOf('=');
        dash = (dash > 1)? dash : resource.length();
        String userId = resource.substring(0, dash);
        return userId;
    }

    public String translateRaw(String id) {
        if ( "0".equals(id)) {
            return "";
        }
        T t = map.get(id);
        if ( t == null ) {
            return NOT_FOUND_TAG + " " + id + " not found in " + this.getClass().getSimpleName() + " " + NOT_FOUND_TAG;
        }
        String resource = t.getLocalizedName();
        return resource;
    }
    
    public static class GenderTranslator extends ResourceTranslator<Gender>{
        private static GenderTranslator instance = null;
        public static GenderTranslator getInstance() {
            if (instance == null) {
                instance = new GenderTranslator();
            }
            return instance;
        }
        
        /**
         * Apparently at some locations there is a "0" gender meaning none. 
         * so here we just translate 0/1 to M,F
         * @see us.mn.state.health.lims.reports.action.implementation.reportBeans.ResourceTranslator#translate(java.lang.String)
         */
        public String translate(String id) {
            if ("0".equals(id)) {
                return "";
            }
            return super.translate(id);
        }
        @SuppressWarnings("unchecked")
        private GenderTranslator() {
            super((List<Gender>) new GenderDAOImpl().getAllGenders());
        }
        
        protected String getKey(Gender d) {
            return d.getGenderType();
        }
    }
    
    
    public static class DictionaryTranslator extends ResourceTranslator<Dictionary>{
        private static DictionaryTranslator instance = null;
        public static DictionaryTranslator getInstance() {
            if (instance == null) {
                instance = new DictionaryTranslator();
            }
            return instance;
        }

        @SuppressWarnings("unchecked")
        public DictionaryTranslator() {
            super((List<Dictionary>) new DictionaryDAOImpl().getAllDictionarys());
        }
        
        protected String getKey(Dictionary d) {
            return d.getId();
        }
    }
}