package org.activityinfo.legacy.shared.model;

/*
 * #%L
 * ActivityInfo Server
 * %%
 * Copyright (C) 2009 - 2013 UNICEF
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public 
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/gpl-3.0.html>.
 * #L%
 */

import com.extjs.gxt.ui.client.data.BaseModelData;
import org.activityinfo.legacy.shared.command.Month;

/**
 * Projection DTO of the ReportingPeriod, IndicatorValue, and Indicator tables.
 * <p/>
 * Each IndicatorRowDTO contains values for a single Site, and a single
 * Indicator, but values (stored as properties) for a series of ReportingPeriod
 */
@Deprecated
public final class IndicatorRowDTO extends BaseModelData implements DTO {

    private int siteId;
    private int activityId;
    private int indicatorId;

    /**
     * @return The id of the site to which this row belongs.
     */
    public int getSiteId() {
        return siteId;
    }

    public void setSiteId(int siteId) {
        this.siteId = siteId;
    }

    /**
     * @return The id of the Activity row to which the row's Site belongs.
     */
    public int getActivityId() {
        return activityId;
    }

    public void setActivityId(int activityId) {
        this.activityId = activityId;
    }

    /**
     * @return The id of the
     * {@link org.activityinfo.server.database.hibernate.entity.Indicator
     * Indicator}
     */
    public int getIndicatorId() {
        return indicatorId;
    }

    public void setIndicatorId(int indicatorId) {
        this.indicatorId = indicatorId;
    }

    /**
     * @return The name of the
     * {@link org.activityinfo.server.database.hibernate.entity.Indicator}
     * .
     */
    public String getIndicatorName() {
        return get("indicatorName");
    }

    public void setIndicatorName(String name) {
        set("indicatorName", name);
    }

    /**
     * @return this Indicator's category
     */
    public String getCategory() {
        return get("category");
    }

    /**
     * Sets this Indicator's category
     */
    public void setCategory(String category) {
        set("category", category);
    }

    /**
     * @return this Indicator's activity name
     */
    public String getActivityName() {
        return get("activityName");
    }

    /**
     * Sets this Indicator's activity name
     */
    public void setActivityName(String name) {
        set("activityName", name);
    }

    /**
     * The value of the Indicator for the
     * {@link org.activityinfo.server.database.hibernate.entity.ReportingPeriod
     * ReportingPeriod} corresponding to the given <code>year</code> and
     * <code>month</code>
     *
     * @param year
     * @param month
     * @return
     */
    public Double getValue(int year, int month) {
        return get(propertyName(year, month));
    }

    public void setValue(int year, int month, Double value) {
        set(propertyName(year, month), value);
    }

    public static String propertyName(int year, int month) {
        return new Month(year, month).getPropertyName();
    }

    public static String propertyName(Month month) {
        return propertyName(month.getYear(), month.getMonth());
    }

    public void setValue(Month month, Double value) {
        setValue(month.getYear(), month.getMonth(), value);
    }

    public static Month monthForProperty(String property) {
        return Month.parseMonth(property.substring(1));
    }
}