org.protempa.ProtempaUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protempa-framework Show documentation
Protempa Framework is the core of Protempa.
There is a newer version: 5.2-Alpha-2
/*
 * #%L
 * Protempa Framework
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package org.protempa;

import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashSet;
import java.util.ResourceBundle;
import java.util.Set;
import java.util.logging.Logger;
import org.protempa.proposition.TemporalProposition;
import org.protempa.proposition.comparator.TemporalPropositionIntervalComparator;

/**
 * Utility methods for the PROTEMPA project. They are not intended to be
 * used outside of projects that use PROTEMPA.
 * 
 * @author Andrew Post
 */
public final class ProtempaUtil {

    private ProtempaUtil() {
    }

    private static class LazyLoggerHolder {

        private static Logger instance =
                Logger.getLogger(ProtempaUtil.class.getPackage().getName());
    }

    /**
     * Gets the logger for this package.
     *
     * @return a {@link Logger} object.
     */
    static Logger logger() {
        return LazyLoggerHolder.instance;
    }

    /**
     * Comparator for comparing proposition definitions by display name.
     */
    public static class PropositionDefinitionDisplayNameComparator implements
            Comparator {

        /**
         * For specifying which display name style to use. Options are:
         * 
         * ABBREVIATED: as in
         * {@link PropositionDefinition#getAbbreviatedDisplayName()}
         * 
REGULAR: as in {@link PropositionDefinition#getDisplayName()}
         * 
         */
        public static enum Style {

            ABBREVIATED,
            REGULAR;
        }
        private final Style style;

        /**
         * Instantiates this comparator with the default display name style
         * ({@link Style.REGULAR}.
         */
        public PropositionDefinitionDisplayNameComparator() {
            this(Style.REGULAR);
        }

        /**
         * Instantiates this comparator to use the short or long display
         * names when doing comparisons.
         *
         * @param style a {@link DisplayNameFormat.Style} representing the
         * regular or abbrevaited display name.
         */
        public PropositionDefinitionDisplayNameComparator(
                Style style) {
            this.style = style;
        }

        @Override
        public int compare(PropositionDefinition k1,
                PropositionDefinition k2) {
            switch (this.style) {
                case REGULAR:
                    return k1.getDisplayName().compareTo(k2.getDisplayName());
                case ABBREVIATED:
                    return k1.getAbbreviatedDisplayName().compareTo(
                            k2.getAbbreviatedDisplayName());
                default:
                    throw new AssertionError("should not be reached");
            }
        }
    }

    /**
     * Checks if the specified array is null, has length zero or has null
     * values. If any of those criteria are me, an
     * {@link IllegalArgumentException} is thrown.
     *
     * @param array an {@link Object[]}.
     * @param arrayName the variable name {@link String} of the array (
     * used in the exception message). Should not be null, or the
     * exception message will not indicate which parameter was erroneously
     * null.
     */
    public static void checkArray(Object[] array, String arrayName) {
        if (array == null) {
            throw new IllegalArgumentException(arrayName
                    + " cannot be null");
        }
        if (array.length == 0) {
            throw new IllegalArgumentException(arrayName
                    + " cannot be empty");
        }
        checkArrayForNullElement(array, arrayName);
    }

    /**
     * Checks if the specified array has any null elements. If so, an
     * [@link IllegalArgumentException is thrown.
     *
     * @param array an {@link Object[]}. Must not be null, or
     * a {@link NullPointerException} will be thrown.
     * @param arrayName the variable name {@link String} of the array (used
     * in the exception message). Should not be null, or the
     * exception message will not indicate which parameter was erroneously
     * null.
     */
    public static void checkArrayForNullElement(Object[] array,
            String arrayName) {
        for (Object elt : array) {
            if (elt == null) {
                throw new IllegalArgumentException(arrayName
                        + " cannot contain null values");
            }
        }
    }

    /**
     * Checks an array for duplicates as checked with the equals
     * method.
     *
     * @param array an {@link Object[]}. Cannot be null.
     * @param arrayName the name {@link String} of the array to use in the
     * error message if a duplicate is found.
     * @throws IllegalArgumentException if a duplicate is found.
     */
    static void checkArrayForDuplicates(Object[] array, String arrayName) {
        if (array.length > 1) {
            if (array.length == 2) {
                if (array[0] == array[1] || 
                        (array[0] != null && array[0].equals(array[1]))) {
                    throw new IllegalArgumentException(arrayName
                            + " cannot contain duplicate elements: "
                            + Arrays.toString(array) + "; " + array[0]);
                }
            } else {
                Set