SiteData.java

/*
 * All Sigmah code is released under the GNU General Public License v3
 * See COPYRIGHT.txt and LICENSE.txt.
 */

package org.sigmah.server.domain;

/*
 * #%L
 * Sigmah
 * %%
 * Copyright (C) 2010 - 2016 URD
 * %%
 * 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 java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.sigmah.server.dao.util.SiteTableColumn;

/**
 * A non-tabular representation of sites used by 
 * map and narrative generators.
 * 
 * @author Alex Bertram
 *
 */
public class SiteData {

	public Object[] values;
	public Map<Integer, String> adminNames = new HashMap<Integer,String>(0);
    public Map<Integer, AdminEntity> adminEntities = new HashMap<Integer,AdminEntity>(0);
	public Map<Integer, Double> indicatorValues = new HashMap<Integer, Double>(0);
	public Map<Integer, Boolean> attributes = new HashMap<Integer, Boolean>(0);

    public SiteData() {
        this.values = new Object[SiteTableColumn.values().length+1];
    }

	public SiteData(Object[] values) {
        this.values = values;
	}

    /**
     * @param column
     * @return the value of the given column
     */
	public <X> X getValue(SiteTableColumn column) {
		return (X) values[column.index()-1];
	}

    /**
     * Sets the value of the given column for this Site
     */
    public void setValue(SiteTableColumn column, Object value) {
        values[column.index()-1] = value;
    }

    /**
     * @return the longitude of this Site
     */
	public double getLongitude() {
		return (Double)getValue(SiteTableColumn.x);
	}

    /**
     *
     * @return the latitude of this Site
     */
	public double getLatitude() {
		return (Double) getValue(SiteTableColumn.y);
	}

    /**
     *
     * @return this Site's ID
     */
    public int getId() {
        return (Integer)getValue(SiteTableColumn.id);
    }

    /**
     *
     * @return true if this Site has non-null lat and long
     */
	public boolean hasLatLong() {
		return  getValue(SiteTableColumn.y) != null &&
                getValue(SiteTableColumn.x) != null;
	}

    /**
     *
     * @return the id of the Activity to which this Site belongs
     */
    public int getActivityId() {
        return (Integer)getValue(SiteTableColumn.activity_id);
    }

    /**
     *
     * @return the id of the database to which this Site belongs
     */
    public int getDatabaseId() {
        return (Integer)getValue(SiteTableColumn.database_id);
    }

    /**
     *
     * @return the name of location with which this Site is associated
     */
    public String getLocationName() {
        return getValue(SiteTableColumn.location_name);
    }

    /**
     *
     * @return the axe routier of the location with which this Site is associated
     */
    public String getLocationAxe() {
        return getValue(SiteTableColumn.location_axe);
    }

    /**
     *
     * @return  the name of the Partner who owns this Site
     */
    public String getPartnerName() {
        return getValue(SiteTableColumn.partner_name);
    }

    /**
     * @return the total value of the indicator with the given Id
     */
    public Double getIndicatorValue(int indicatorId) {
        return indicatorValues.get(indicatorId);
    }


    /**
     *
     * @return  the date on which work at this Site began
     */
    public Date getDate1() {
        return getValue(SiteTableColumn.date1);
    }

    /**
     *
     * @return  the date on which work at this Site ended
     */
    public Date getDate2() {
        return getValue(SiteTableColumn.date2);
    }

    /**
     *
     * @return  the id of the Partner who owns this Site
     */
    public int getPartnerId() {
        return (Integer)getValue(SiteTableColumn.partner_id);
    }

    /**
     *
     * @return  the plain-text comments associated with this Site
     */
    public String getComments() {
        return getValue(SiteTableColumn.comments);
    }

    /**
     * @return the value of the Attribute with the given Id for this Site
     */
    public Boolean getAttributeValue(int attributeId) {
        return attributes.get(attributeId);
    }

    /**
     * Sets the total value for the indicator at this Site
     */
    public void setIndicatorValue(int indicatorId, Double value) {
        indicatorValues.put(indicatorId, value);
    }
}