Report.java

package org.sigmah.shared.dto.pivot.model;

/*
 * #%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 javax.xml.bind.annotation.*;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import org.sigmah.shared.dto.pivot.content.ReportContent;

/**
 *
 * Describes a document that contains a series of <code>ReportElement</code>s
 *  (e.g. Tables, Charts, etc} and is bound to a time frame.
 *
 * @see org.sigmah.shared.report.model.ReportElement
 *
 * @author Alex Bertram
 */
@XmlRootElement(name="report")
public class Report extends ReportElement<ReportContent> implements Serializable {


    private List<ReportElement> elements = new ArrayList<ReportElement>();

	private String fileName;
    private String description;

    private ReportFrequency frequency;
    private Integer day = null;

    public static final int LAST_DAY_OF_MONTH = 28;

    public Report() {
		
	}

    @XmlElement
    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * @return The list of report elements included in this report.
     */
    @XmlElements({
            @XmlElement(name="pivotTable", type=PivotTableElement.class),
//            @XmlElement(name="pivotChart", type=PivotChartElement.class),
//            @XmlElement(name="table", type=TableElement.class),
//            @XmlElement(name="map", type=MapElement.class),
            @XmlElement(name="static", type=StaticElement.class)
    })
    @XmlElementWrapper(name="elements")
	public List<ReportElement> getElements() {
		return elements;
	}

    public <T extends ReportElement> T getElement(int index) {
        return (T) elements.get(index);
    }

	public void setElements(List<ReportElement> elements) {
		this.elements = elements;
	}

    /**
     * Adds a ReportElement to this report's definition.
     *
     * @param element A <code>ReportElement</code>
     */
	public void addElement(ReportElement element) {
		elements.add(element);
	}

    /**
     *
     * @return Suggested filename for tbis report if it is saved to disk/downloaded. Does not contain
     * the file extension.
     */
    @XmlElement
	public String getFileName() {
		return fileName;
	}

    /**
     * Sets the suggested filename for this report in the event it is saved to disk/downloaded.
     * Should not
     * contain the extension
     *
     * @param fileName The suggested filename, without extension
     */
	public void setFileName(String fileName) {
		this.fileName = fileName;
	}

    /**
     * Gets the frequency of this report
     *
     * @return the frequency of this report
     */
    @XmlAttribute(name="frequency")
    public ReportFrequency getFrequency() {
        return frequency;
    }

    /**
     * Sets the frequency of this report
     *
     * @param frequency The frequency of this report
     */
    public void setFrequency(ReportFrequency frequency) {
        this.frequency = frequency;
    }


    /**
     * Gets the day on which the report is to be mailed.
     *
     * If the subscription frequency is
     * <code>WEEKLY</code>, then this value refers to the
     * day of the week (0=Sunday, 6=Saturday). If the frequency is <code>MONTHLY</code> this refers to the
     * day of the month (1..28). A value of {@link Report#LAST_DAY_OF_MONTH} (28)
     * indicats that the report will be mailed on the last day of the month, whether this the 28th, the 30th, or the 31st.
     *
     * @return the day on which the report is to be mailed.
     *
     */
    @XmlAttribute
    public Integer getDay() {
        return day;
    }

    /**
     * Sets the day on which the report should be mailed.
     *
     * @param day For <code>WEEKLY</code> subscriptions, 0=Sunday, 6=Saturday. For <code>MONTHLY</code>,
     * subscriptions, 1=first day of month,2,3,4...28=<code>LAST_DAY_OF_MONTH</code>
     */
    public void setDay(Integer day) {
        this.day = day;
    }
}