net.sf.dynamicreports.report.definition.DRITemplateDesign 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.
There is a newer version: 6.20.1
Show newest version
/*
 * DynamicReports - Free Java reporting library for creating reports dynamically
 *
 * Copyright (C) 2010 - 2018 Ricardo Mariaca and the Dynamic Reports Contributors
 * http://www.dynamicreports.org
 *
 * 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.report.definition;

import net.sf.dynamicreports.report.constant.PageOrientation;
import net.sf.dynamicreports.report.constant.WhenNoDataType;
import net.sf.dynamicreports.report.constant.WhenResourceMissingType;
import net.sf.dynamicreports.report.exception.DRException;

import java.io.Serializable;
import java.util.List;

/**
 * DRITemplateDesign interface.
 *
 * @author Ricardo Mariaca ([email protected])
 * @version $Id: $Id
 */
public interface DRITemplateDesign extends Serializable {

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

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

    /**
     * isDefinedParameter.
     *
     * @param name a {@link java.lang.String} object.
     * @return a boolean.
     */
    public boolean isDefinedParameter(String name);

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

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

    /**
     * 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();

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

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

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

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

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

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

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

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

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

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

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

    /**
     * getTitleComponentsCount.
     *
     * @return a int.
     */
    public int getTitleComponentsCount();

    /**
     * getPageHeaderComponentsCount.
     *
     * @return a int.
     */
    public int getPageHeaderComponentsCount();

    /**
     * getPageFooterComponentsCount.
     *
     * @return a int.
     */
    public int getPageFooterComponentsCount();

    /**
     * getColumnHeaderComponentsCount.
     *
     * @return a int.
     */
    public int getColumnHeaderComponentsCount();

    /**
     * getColumnFooterComponentsCount.
     *
     * @return a int.
     */
    public int getColumnFooterComponentsCount();

    /**
     * getLastPageFooterComponentsCount.
     *
     * @return a int.
     */
    public int getLastPageFooterComponentsCount();

    /**
     * getSummaryComponentsCount.
     *
     * @return a int.
     */
    public int getSummaryComponentsCount();

    /**
     * getNoDataComponentsCount.
     *
     * @return a int.
     */
    public int getNoDataComponentsCount();

    /**
     * getBackgroundComponentsCount.
     *
     * @return a int.
     */
    public int getBackgroundComponentsCount();

    /**
     * getDesign.
     *
     * @return a T object.
     * @throws net.sf.dynamicreports.report.exception.DRException if any.
     */
    public T getDesign() throws DRException;
}