net.sf.dynamicreports.design.definition.DRIDesignReport Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dynamicreports-core Show documentation
DynamicReports is an open source Java reporting library based on JasperReports. It allows to create dynamic report designs and it doesn't need a visual report designer. You can very quickly create reports and produce documents that can be displayed, printed or exported into many popular formats such as PDF, Excel, Word and others.
The newest version!
/*
 * DynamicReports - Free Java reporting library for creating reports dynamically
 *
 * Copyright (C) 2010 - 2018 Ricardo Mariaca and the Dynamic Reports Contributors
 *
 * This file is part of DynamicReports.
 *
 * DynamicReports is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * DynamicReports 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with DynamicReports. If not, see .
 */
package net.sf.dynamicreports.design.definition;

import net.sf.dynamicreports.design.definition.expression.DRIDesignComplexExpression;
import net.sf.dynamicreports.design.definition.expression.DRIDesignExpression;
import net.sf.dynamicreports.design.definition.expression.DRIDesignJasperExpression;
import net.sf.dynamicreports.design.definition.expression.DRIDesignSimpleExpression;
import net.sf.dynamicreports.design.definition.expression.DRIDesignSystemExpression;
import net.sf.dynamicreports.design.definition.style.DRIDesignStyle;
import net.sf.dynamicreports.jasper.base.tableofcontents.JasperTocHeading;
import net.sf.dynamicreports.report.constant.Orientation;
import net.sf.dynamicreports.report.constant.RunDirection;
import net.sf.dynamicreports.report.constant.WhenNoDataType;
import net.sf.dynamicreports.report.constant.WhenResourceMissingType;
import net.sf.dynamicreports.report.definition.DRIScriptlet;
import net.sf.dynamicreports.report.definition.DRITableOfContentsCustomizer;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.ResourceBundle;

/**
 * DRIDesignReport interface.
 *
 * @author Ricardo Mariaca
 * 
 */
public interface DRIDesignReport extends Serializable {

    /**
     * getTemplateDesign.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignTemplateDesign} object.
     */
    public DRIDesignTemplateDesign getTemplateDesign();

    /**
     * getReportName.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getReportName();

    /**
     * getLocale.
     *
     * @return a {@link java.util.Locale} object.
     */
    public Locale getLocale();

    /**
     * getResourceBundle.
     *
     * @return a {@link java.util.ResourceBundle} object.
     */
    public ResourceBundle getResourceBundle();

    /**
     * getResourceBundleName.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getResourceBundleName();

    /**
     * isIgnorePagination.
     *
     * @return a boolean.
     */
    public boolean isIgnorePagination();

    /**
     * getProperties.
     *
     * @return a {@link java.util.Properties} object.
     */
    public Properties getProperties();

    /**
     * getQuery.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignQuery} object.
     */
    public DRIDesignQuery getQuery();

    /**
     * getPage.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignPage} object.
     */
    public DRIDesignPage getPage();

    /**
     * getWhenNoDataType.
     *
     * @return a {@link net.sf.dynamicreports.report.constant.WhenNoDataType} object.
     */
    public WhenNoDataType getWhenNoDataType();

    /**
     * getWhenResourceMissingType.
     *
     * @return a {@link net.sf.dynamicreports.report.constant.WhenResourceMissingType} object.
     */
    public WhenResourceMissingType getWhenResourceMissingType();

    /**
     * isTitleOnANewPage.
     *
     * @return a boolean.
     */
    public boolean isTitleOnANewPage();

    /**
     * isSummaryOnANewPage.
     *
     * @return a boolean.
     */
    public boolean isSummaryOnANewPage();

    /**
     * isSummaryWithPageHeaderAndFooter.
     *
     * @return a boolean.
     */
    public boolean isSummaryWithPageHeaderAndFooter();

    /**
     * isFloatColumnFooter.
     *
     * @return a boolean.
     */
    public boolean isFloatColumnFooter();

    /**
     * getPrintOrder.
     *
     * @return a {@link net.sf.dynamicreports.report.constant.Orientation} object.
     */
    public Orientation getPrintOrder();

    /**
     * getColumnDirection.
     *
     * @return a {@link net.sf.dynamicreports.report.constant.RunDirection} object.
     */
    public RunDirection getColumnDirection();

    /**
     * getLanguage.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getLanguage();

    /**
     * isTableOfContents.
     *
     * @return a boolean.
     */
    public boolean isTableOfContents();

    /**
     * getTableOfContentsHeadings.
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getTableOfContentsHeadings();

    /**
     * getTableOfContentsCustomizer.
     *
     * @return a {@link net.sf.dynamicreports.report.definition.DRITableOfContentsCustomizer} object.
     */
    public DRITableOfContentsCustomizer getTableOfContentsCustomizer();

    /**
     * getFilterExpression.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.expression.DRIDesignExpression} object.
     */
    public DRIDesignExpression getFilterExpression();

    /**
     * getParameters.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getParameters();

    /**
     * getParameterValues.
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getParameterValues();

    /**
     * getScriptlets.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getScriptlets();

    /**
     * getFields.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getFields();

    /**
     * getSystemExpressions.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getSystemExpressions();

    /**
     * getJasperExpressions.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getJasperExpressions();

    /**
     * getSimpleExpressions.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getSimpleExpressions();

    /**
     * getStyles.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getStyles();

    /**
     * getGroups.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getGroups();

    /**
     * getVariables.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getVariables();

    /**
     * getComplexExpressions.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getComplexExpressions();

    /**
     * getSorts.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getSorts();

    /**
     * getDatasets.
     *
     * @return a {@link java.util.Collection} object.
     */
    public Collection getDatasets();

    /**
     * getTitleBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getTitleBand();

    /**
     * getPageHeaderBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getPageHeaderBand();

    /**
     * getPageFooterBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getPageFooterBand();

    /**
     * getColumnHeaderBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getColumnHeaderBand();

    /**
     * getColumnFooterBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getColumnFooterBand();

    /**
     * getDetailBands.
     *
     * @return a {@link java.util.List} object.
     */
    public List getDetailBands();

    /**
     * getLastPageFooterBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getLastPageFooterBand();

    /**
     * getSummaryBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getSummaryBand();

    /**
     * getNoDataBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getNoDataBand();

    /**
     * getBackgroundBand.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignBand} object.
     */
    public DRIDesignBand getBackgroundBand();
}