TestCatalogAction.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) ITECH, University of Washington, Seattle WA.  All Rights Reserved.
 */

package us.mn.state.health.lims.testconfiguration.action;

import org.apache.commons.beanutils.PropertyUtils;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.validator.GenericValidator;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.validator.DynaValidatorForm;
import us.mn.state.health.lims.common.action.BaseAction;
import us.mn.state.health.lims.common.services.LocalizationService;
import us.mn.state.health.lims.common.services.ResultLimitService;
import us.mn.state.health.lims.common.services.TestService;
import us.mn.state.health.lims.common.services.TypeOfTestResultService;
import us.mn.state.health.lims.common.util.SystemConfiguration;
import us.mn.state.health.lims.common.util.resources.ResourceLocator;
import us.mn.state.health.lims.dictionary.dao.DictionaryDAO;
import us.mn.state.health.lims.dictionary.daoimpl.DictionaryDAOImpl;
import us.mn.state.health.lims.dictionary.valueholder.Dictionary;
import us.mn.state.health.lims.panel.valueholder.Panel;
import us.mn.state.health.lims.resultlimits.valueholder.ResultLimit;
import us.mn.state.health.lims.test.daoimpl.TestDAOImpl;
import us.mn.state.health.lims.test.valueholder.Test;
import us.mn.state.health.lims.testconfiguration.beans.ResultLimitBean;
import us.mn.state.health.lims.testconfiguration.beans.TestCatalogBean;
import us.mn.state.health.lims.testresult.valueholder.TestResult;
import us.mn.state.health.lims.typeofsample.valueholder.TypeOfSample;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Locale;

public class TestCatalogAction extends BaseAction {
    private DictionaryDAO dictionaryDAO = new DictionaryDAOImpl();


    @Override
    protected ActionForward performAction(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
        DynaValidatorForm dynaForm = (DynaValidatorForm)form;
        List<TestCatalogBean> testList = createTestList();
        PropertyUtils.setProperty(dynaForm, "testList", testList);

        List<String> testSectionList = new ArrayList<String>();
        for( TestCatalogBean catalogBean : testList){
            if( !testSectionList.contains( catalogBean.getTestUnit())){
                testSectionList.add(catalogBean.getTestUnit());
            }
        }
        PropertyUtils.setProperty(dynaForm, "testSectionList", testSectionList);



        return mapping.findForward(FWD_SUCCESS);
    }

    private List<TestCatalogBean> createTestList() {
        List<TestCatalogBean> beanList = new ArrayList<TestCatalogBean>();

        List<Test> testList = new TestDAOImpl().getAllTests(false);

        for( Test test : testList){

            TestCatalogBean bean = new TestCatalogBean();
            TestService testService = new TestService(test);
            String resultType = testService.getResultType();
            bean.setEnglishName(test.getLocalizedTestName().getEnglish());
            bean.setFrenchName(test.getLocalizedTestName().getFrench());
            bean.setEnglishReportName(test.getLocalizedReportingName().getEnglish());
            bean.setFrenchReportName(test.getLocalizedReportingName().getFrench());
            bean.setTestSortOrder(Integer.parseInt(test.getSortOrder()));
            bean.setTestUnit(testService.getTestSectionName());
            bean.setPanel(createPanelList(testService));
            bean.setResultType(resultType);
            TypeOfSample typeOfSample = testService.getTypeOfSample();
            bean.setSampleType(typeOfSample != null ? typeOfSample.getLocalizedName() : "n/a");
            Locale locale = SystemConfiguration.getInstance().getDefaultLocale();
            //bean.setOrderable(test.getOrderable() ? "Orderable" : "Not orderable");
            bean.setOrderable(test.getOrderable() ? ResourceLocator.getInstance().getMessageResources().getMessage(locale, "orderable.text.field") 
            		: ResourceLocator.getInstance().getMessageResources().getMessage(locale, "not_orderable.text.field"));
            //bean.setActive(test.isActive() ? "Active" : "Not active");
            bean.setActive(test.isActive() ? ResourceLocator.getInstance().getMessageResources().getMessage(locale, "active.text.field") 
            		: ResourceLocator.getInstance().getMessageResources().getMessage(locale, "not_active.text.field"));
            bean.setUom(testService.getUOM(false));
            if( TypeOfTestResultService.ResultType.NUMERIC.matches(resultType)) {
                bean.setSignificantDigits(testService.getPossibleTestResults().get(0).getSignificantDigits());
                bean.setHasLimitValues(true);
                bean.setResultLimits(getResultLimits(test, bean.getSignificantDigits()));
            }
            bean.setHasDictionaryValues(TypeOfTestResultService.ResultType.isDictionaryVariant(bean.getResultType()));
            if( bean.isHasDictionaryValues()){
                bean.setDictionaryValues(createDictionaryValues(testService));
                bean.setReferenceValue(createReferenceValueForDictionaryType(test));
            }
            beanList.add(bean);
        }

        Collections.sort(beanList, new Comparator<TestCatalogBean>() {
            @Override
            public int compare(TestCatalogBean o1, TestCatalogBean o2) {
                //sort by test section, sample type, panel, sort order
                int comparison = o1.getTestUnit().compareTo(o2.getTestUnit());
                if (comparison != 0) {
                    return comparison;
                }

                comparison = o1.getSampleType().compareTo(o2.getSampleType());
                if (comparison != 0) {
                    return comparison;
                }

                comparison = o1.getPanel().compareTo(o2.getPanel());
                if (comparison != 0) {
                    return comparison;
                }

                return o1.getTestSortOrder() - o2.getTestSortOrder();
            }
        });

        return beanList;
    }

    private List<ResultLimitBean> getResultLimits(Test test, String significantDigits) {
        List<ResultLimitBean> limitBeans = new ArrayList<ResultLimitBean>();

        List<ResultLimit> resultLimitList = ResultLimitService.getResultLimits(test);

        Collections.sort(resultLimitList, new Comparator<ResultLimit>() {
            @Override
            public int compare(ResultLimit o1, ResultLimit o2) {
                return (int) (o1.getMinAge() - o2.getMinAge());
            }
        });

        for( ResultLimit limit : resultLimitList){
            ResultLimitBean bean = new ResultLimitBean();
            bean.setNormalRange(ResultLimitService.getDisplayReferenceRange(limit, significantDigits, "-"));
            bean.setValidRange(ResultLimitService.getDisplayValidRange(limit, significantDigits, "-"));
            bean.setGender(limit.getGender());
            bean.setAgeRange( ResultLimitService.getDisplayAgeRange(limit, "-"));
            limitBeans.add(bean);
        }
        return limitBeans;
    }

    private String createReferenceValueForDictionaryType(Test test) {
        List<ResultLimit> resultLimits = ResultLimitService.getResultLimits(test);

        if( resultLimits.isEmpty() ){
            return "n/a";
        }

        return ResultLimitService.getDisplayReferenceRange(resultLimits.get(0),null, null);

    }

    private List<String> createDictionaryValues(TestService testService) {
        List<String> dictionaryList = new ArrayList<String>();
        List<TestResult> testResultList = testService.getPossibleTestResults();
        for( TestResult testResult : testResultList){
            CollectionUtils.addIgnoreNull(dictionaryList, getDictionaryValue(testResult));
        }

        return dictionaryList;
    }

    private String getDictionaryValue(TestResult testResult) {

        if (TypeOfTestResultService.ResultType.isDictionaryVariant(testResult.getTestResultType())) {
            Dictionary dictionary = dictionaryDAO.getDataForId(testResult.getValue());
            String displayValue = dictionary.getLocalizedName();

            if ("unknown".equals(displayValue)) {
                displayValue = !GenericValidator.isBlankOrNull(dictionary.getDictEntry()) ?
                        dictionary.getDictEntry() : dictionary.getLocalAbbreviation();
            }

            if (testResult.getIsQuantifiable()) {
                displayValue += " Qualifiable";
            }
            return displayValue;
        }

        return null;
    }

    private String createPanelList(TestService testService) {
        StringBuilder builder = new StringBuilder();

        List<Panel> panelList = testService.getPanels();
        for(Panel panel : panelList){
            builder.append(LocalizationService.getLocalizedValueById(panel.getLocalization().getId()));
            builder.append(", ");
        }

        String panelString = builder.toString();
        if( panelString.isEmpty()){
            panelString = "None";
        }else{
            panelString = panelString.substring(0, panelString.length() - 2 );
        }

        return panelString;
    }


    @Override
    protected String getPageTitleKey() {
        return null;
    }

    @Override
    protected String getPageSubtitleKey() {
        return null;
    }
}