001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.experiment.evaluation;
031
032import net.sf.jasperreports.engine.JRException;
033import net.sf.jasperreports.engine.JasperPrint;
034
035/**
036 * The result of the analysis of raw data. 
037 * <p>
038 * {@link AnalysisResult}s are capable of producing summary and
039 * detailed information in the form of a {@link String} as well
040 * as producing a {@link JasperPrint} objects containing a renderable
041 * summary and detailed reports.
042 * 
043 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
044 */
045public interface AnalysisResult {
046        /**
047         * Get a {@link JasperPrint} summarising the result.
048         * @param title a title to add to the report
049         * @param info information to print at the beginning of the report
050         * 
051         * @return a {@link String} summarising the result
052         * @throws JRException 
053         */
054        public JasperPrint getSummaryReport(String title, String info) throws JRException;
055        
056        /**
057         * Get a {@link JasperPrint} detailing the result.
058         * @param title a title to add to the report
059         * @param info information to print at the beginning of the report
060         * 
061         * @return a {@link JasperPrint} detailing the result.
062         * @throws JRException 
063         */
064        public JasperPrint getDetailReport(String title, String info) throws JRException;
065        
066        /**
067         * Get a {@link String} summarising the result.
068         * 
069         * @return a {@link String} summarising the result
070         */
071        public String getSummaryReport();
072        
073        /**
074         * Get a {@link String} detailing the result.
075         * 
076         * @return a {@link String} detailing the result
077         */
078        public String getDetailReport();
079}