org.openmrs.module.kenyaemr.util.EmrUtils.java Source code

Introduction

Here is the source code for org.openmrs.module.kenyaemr.util.EmrUtils.java

Source

/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://license.openmrs.org
 *
 * 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.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */

package org.openmrs.module.kenyaemr.util;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.time.DateUtils;
import org.openmrs.Concept;
import org.openmrs.Encounter;
import org.openmrs.EncounterType;
import org.openmrs.Form;
import org.openmrs.Patient;
import org.openmrs.Person;
import org.openmrs.Provider;
import org.openmrs.User;
import org.openmrs.api.EncounterService;
import org.openmrs.api.context.Context;
import org.openmrs.module.kenyaemr.Dictionary;

import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.List;

/**
 * Miscellaneous utility methods
 */
public class EmrUtils {

    /**
     * Checks whether a date has any time value
     * @param date the date
     * @return true if the date has time
     * @should return true only if date has time
     */
    public static boolean dateHasTime(Date date) {
        Calendar cal = Calendar.getInstance();
        cal.setTime(date);
        return cal.get(Calendar.HOUR) != 0 || cal.get(Calendar.MINUTE) != 0 || cal.get(Calendar.SECOND) != 0
                || cal.get(Calendar.MILLISECOND) != 0;
    }

    /**
     * Checks if a given date is today
     * @param date the date
     * @return true if date is today
     */
    public static boolean isToday(Date date) {
        return DateUtils.isSameDay(date, new Date());
    }

    /**
     * Converts a WHO stage concept to a WHO stage number
     * @param c the WHO stage concept
     * @return the WHO stage number (null if the concept isn't a WHO stage)
     */
    public static Integer whoStage(Concept c) {
        if (c != null) {
            if (c.equals(Dictionary.getConcept(Dictionary.WHO_STAGE_1_ADULT))
                    || c.equals(Dictionary.getConcept(Dictionary.WHO_STAGE_1_PEDS))) {
                return 1;
            }
            if (c.equals(Dictionary.getConcept(Dictionary.WHO_STAGE_2_ADULT))
                    || c.equals(Dictionary.getConcept(Dictionary.WHO_STAGE_2_PEDS))) {
                return 2;
            }
            if (c.equals(Dictionary.getConcept(Dictionary.WHO_STAGE_3_ADULT))
                    || c.equals(Dictionary.getConcept(Dictionary.WHO_STAGE_3_PEDS))) {
                return 3;
            }
            if (c.equals(Dictionary.getConcept(Dictionary.WHO_STAGE_4_ADULT))
                    || c.equals(Dictionary.getConcept(Dictionary.WHO_STAGE_4_PEDS))) {
                return 4;
            }
        }
        return null;
    }

    /**
     * Parses a CSV list of strings, returning all trimmed non-empty values
     * @param csv the CSV string
     * @return the concepts
     */
    public static List<String> parseCsv(String csv) {
        List<String> values = new ArrayList<String>();

        for (String token : csv.split(",")) {
            token = token.trim();

            if (!StringUtils.isEmpty(token)) {
                values.add(token);
            }
        }
        return values;
    }

    /**
     * Parses a CSV list of concept ids, UUIDs or mappings
     * @param csv the CSV string
     * @return the concepts
     */
    public static List<Concept> parseConcepts(String csv) {
        List<String> identifiers = parseCsv(csv);
        List<Concept> concepts = new ArrayList<Concept>();

        for (String identifier : identifiers) {
            if (StringUtils.isNumeric(identifier)) {
                concepts.add(Context.getConceptService().getConcept(Integer.valueOf(identifier)));
            } else {
                concepts.add(Dictionary.getConcept(identifier));
            }
        }
        return concepts;
    }

    /**
     * Unlike in OpenMRS core, a user can only be one provider in KenyaEMR
     * @param user the user
     * @return the provider or null
     */
    public static Provider getProvider(User user) {
        Person person = user.getPerson();
        Collection<Provider> providers = Context.getProviderService().getProvidersByPerson(person);
        return providers.size() > 0 ? providers.iterator().next() : null;
    }

    /**
     * Finds the last encounter during the program enrollment with the given encounter type
     *
     * @param type the encounter type
     *
     * @return the encounter
     */
    public static Encounter lastEncounter(Patient patient, EncounterType type) {
        List<Encounter> encounters = Context.getEncounterService().getEncounters(patient, null, null, null, null,
                Collections.singleton(type), null, null, null, false);
        return encounters.size() > 0 ? encounters.get(encounters.size() - 1) : null;
    }

    /**
     * Finds the first encounter during the program enrollment with the given encounter type
     *
     * @param type the encounter type
     *
     * @return the encounter
     */
    public static Encounter firstEncounter(Patient patient, EncounterType type) {
        List<Encounter> encounters = Context.getEncounterService().getEncounters(patient, null, null, null, null,
                Collections.singleton(type), null, null, null, false);
        return encounters.size() > 0 ? encounters.get(0) : null;
    }

    /**
     * Finds the last encounter of a given type entered via a given form.
     *
     * @param encounterType the type of encounter
     * @param form          the form through which the encounter was entered.
     */
    public static Encounter encounterByForm(Patient patient, EncounterType encounterType, Form form) {
        List<Form> forms = null;
        if (form != null) {
            forms = new ArrayList<Form>();
            forms.add(form);
        }
        EncounterService encounterService = Context.getEncounterService();
        List<Encounter> encounters = encounterService.getEncounters(patient, null, null, null, forms,
                Collections.singleton(encounterType), null, null, null, false);
        return encounters.size() > 0 ? encounters.get(encounters.size() - 1) : null;
    }
}