/*
 * This file is part of LibrePlan
 *
 * Copyright (C) 2009-2010 Fundación para o Fomento da Calidade Industrial e
 *                         Desenvolvemento Tecnolóxico de Galicia
 * Copyright (C) 2010-2011 Igalia, S.L.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.libreplan.business.planner.entities;

import static org.libreplan.business.i18n.I18nHelper._;

import java.util.List;

import org.libreplan.business.common.BaseEntity;

/**
 * Represents entity AssignmentFunction.
 *
 * @author Diego Pino García <dpino@igalia.com>
 */
public abstract class AssignmentFunction extends BaseEntity {

    /**
     * This method goes over the {@link ResourceAllocation} list and apply the assignment function if it is defined.
     *
     * As this is called at the end of {@link Task#doAllocation} and a flat allocation was already applied before.
     * If assignment function was set to manual it is reseted to flat again.
     *
     * @param resourceAllocations
     *            List of {@link ResourceAllocation}
     */
    public static void applyAssignmentFunctionsIfAny(List<ResourceAllocation<?>> resourceAllocations) {
        for (ResourceAllocation<?> resourceAllocation : resourceAllocations) {
            AssignmentFunction assignmentFunction = resourceAllocation.getAssignmentFunction();
            if (assignmentFunction != null) {
                if (assignmentFunction.isManual()) {
                    // Reset to flat
                    resourceAllocation.setAssignmentFunctionWithoutApply(null);
                } else {
                    assignmentFunction.applyTo(resourceAllocation);
                }
            }
        }
    }

    /**
     * This method applies the function to the received resourceAllocation
     * <i>This method is intended to be overridden by subclasses</i>
     *
     * @param resourceAllocation
     */
    public abstract void applyTo(ResourceAllocation<?> resourceAllocation);

    public abstract String getName();

    public abstract boolean isManual();

    public enum AssignmentFunctionName {
        FLAT(_("Flat")),
        MANUAL(_("Manual")),
        STRETCHES(_("Stretches")),
        INTERPOLATION(_("Interpolation")),
        SIGMOID(_("Sigmoid"));

        private String name;

        AssignmentFunctionName(String name) {
            this.name = name;
        }

        @Override
        public String toString() {
            return name;
        }
    }

}