org.openmrs.ISO8601Duration.java Source code

Introduction

Here is the source code for org.openmrs.ISO8601Duration.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;

import java.util.Date;

import org.apache.commons.lang3.time.DateUtils;
import org.openmrs.api.APIException;

/**
 * Duration represented using ISO 8601 duration codes
 * 
 * @since 1.10
 */
public class ISO8601Duration {

    public static final String SECONDS_CODE = "S";

    public static final String MINUTES_CODE = "m";

    public static final String HOURS_CODE = "H";

    public static final String DAYS_CODE = "D";

    public static final String WEEKS_CODE = "W";

    public static final String MONTHS_CODE = "M";

    public static final String YEARS_CODE = "Y";

    public static final String RECURRING_INTERVAL_CODE = "R";

    public static final String CONCEPT_SOURCE_UUID = "cb523690-9012-4e72-b8bf-4253e1b1a687";

    private static final int SECONDS_PER_MINUTE = 60;

    private static final int MINUTES_PER_HOUR = 60;

    private static final int HOURS_PER_DAY = 24;

    private static final int SECONDS_PER_HOUR = SECONDS_PER_MINUTE * MINUTES_PER_HOUR;

    private static final int SECONDS_PER_DAY = SECONDS_PER_HOUR * HOURS_PER_DAY;

    private final Integer duration;

    private final String code;

    public ISO8601Duration(Integer duration, String code) {
        this.duration = duration;
        this.code = code;
    }

    /**
     * Add this duration to given startDate
     * 
     * @param startDate
     * @param frequency is used to calculate time to be added to startDate when duration unit is
     *            'Recurring Interval'
     * @return date which is startDate plus duration
     */
    public Date addToDate(Date startDate, OrderFrequency frequency) {
        if (SECONDS_CODE.equals(code))
            return DateUtils.addSeconds(startDate, duration);
        if (MINUTES_CODE.equals(code))
            return DateUtils.addMinutes(startDate, duration);
        if (HOURS_CODE.equals(code))
            return DateUtils.addHours(startDate, duration);
        if (DAYS_CODE.equals(code))
            return DateUtils.addDays(startDate, duration);
        if (WEEKS_CODE.equals(code))
            return DateUtils.addWeeks(startDate, duration);
        if (MONTHS_CODE.equals(code))
            return DateUtils.addMonths(startDate, duration);
        if (YEARS_CODE.equals(code))
            return DateUtils.addYears(startDate, duration);
        if (RECURRING_INTERVAL_CODE.equals(code)) {
            if (frequency == null)
                throw new APIException("Frequency can not be null when duration in Recurring Interval");
            return DateUtils.addSeconds(startDate,
                    (int) (duration * SECONDS_PER_DAY / frequency.getFrequencyPerDay()));
        }
        throw new APIException(String.format("Unknown code '%s' for ISO8601 duration units", code));
    }

    /**
     * Returns concept reference term code of the mapping to the ISO8601 concept source
     * 
     * @param durationUnits
     * @return a string which is reference term code
     * @should return null if the concept has no mapping to the ISO8601 source
     * @should return the code for the term of the mapping to the ISO8601 source
     */
    public static String getCode(Concept durationUnits) {
        for (ConceptMap conceptMapping : durationUnits.getConceptMappings()) {
            ConceptReferenceTerm conceptReferenceTerm = conceptMapping.getConceptReferenceTerm();
            if (ISO8601Duration.CONCEPT_SOURCE_UUID.equals(conceptReferenceTerm.getConceptSource().getUuid())) {
                return conceptReferenceTerm.getCode();
            }
        }
        return null;
    }
}