org.dspace.app.statistics.Report Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
There is a newer version: 8.0
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.app.statistics;

import java.util.Date;

/**
 * Sn interface to a generic report generating
 * class, and to provide the polymorphism necessary to allow the report
 * generator to generate any number of different formats of report
 *
 * Note: This used to be an abstract class, but has been made an interface as there wasn't
 * any logic contained within it. It's also been made public, so that you can create a Report
 * type without monkeying about in the statistics package.
 *
 * @author Richard Jones
 */
public interface Report {
    /**
     * output any top headers that this page needs
     *
     * @return a string containing the header for the report
     */
    public abstract String header();

    /**
     * output any top headers that this page needs
     *
     * @param title the title of the report, useful for email subjects or
     *              HTML headers
     * @return a string containing the header for the report
     */
    public abstract String header(String title);

    /**
     * output the title in the relevant format.  This requires that the title
     * has been set with setMainTitle()
     *
     * @return a string containing the title of the report
     */
    public abstract String mainTitle();

    /**
     * output the date range in the relevant format.  This requires that the
     * date ranges have been set using setStartDate() and setEndDate()
     *
     * @return a string containing date range information
     */
    public abstract String dateRange();

    /**
     * output the section header in the relevant format
     *
     * @param title the title of the current section header
     * @return a string containing the formatted section header
     */
    public abstract String sectionHeader(String title);

    /**
     * output the report block based on the passed statistics object array
     *
     * @param content a statistics object to form the basis of the displayed
     *                stat block
     * @return a string containing the formatted statistics block
     */
    public abstract String statBlock(Statistics content);

    /**
     * output the floor information in the relevant format
     *
     * @param floor the floor value for the statistics block
     * @return a string containing the formatted floor information
     */
    public abstract String floorInfo(int floor);

    /**
     * output the explanation of the stat block in the relevant format
     *
     * @param explanation the explanatory or clarification text for the stats
     * @return a string containing the formatted explanation
     */
    public abstract String blockExplanation(String explanation);

    /**
     * output the final footers for this file
     *
     * @return a string containing the report footer
     */
    public abstract String footer();

    /**
     * set the main title for the report
     *
     * @param name       the name of the service
     * @param serverName the name of the server
     */
    public abstract void setMainTitle(String name, String serverName);

    /**
     * add a statistics block to the report to the class register
     *
     * @param stat the statistics object to be added to the report
     */
    public abstract void addBlock(Statistics stat);

    /**
     * render the report
     *
     * @return a string containing the full content of the report
     */
    public abstract String render();

    /**
     * set the starting date for the report
     *
     * @param start the start date for the report
     */
    public abstract void setStartDate(Date start);

    /**
     * set the end date for the report
     *
     * @param end the end date for the report
     */
    public abstract void setEndDate(Date end);
}