net.sf.dynamicreports.report.definition.ReportParameters 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.report.definition;

import java.sql.Connection;
import java.util.Locale;

/**
 * ReportParameters interface.
 *
 * @author Ricardo Mariaca
 * 
 */
public interface ReportParameters {
    /**
     * Constant CROSSTAB_ROW_COUNTER="CROSSTAB_ROW_NUMBER"
     */
    public static final String CROSSTAB_ROW_COUNTER = "CROSSTAB_ROW_NUMBER";

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

    /**
     * getValue.
     *
     * @param value a {@link net.sf.dynamicreports.report.definition.DRIValue} object.
     * @param    a T object.
     * @return a T object.
     */
    public  T getValue(DRIValue value);

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

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

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

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

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

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

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

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

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

    /**
     * getGroupCount.
     *
     * @param groupName a {@link java.lang.String} object.
     * @return a {@link java.lang.Integer} object.
     */
    public Integer getGroupCount(String groupName);

    /**
     * getConnection.
     *
     * @return a {@link java.sql.Connection} object.
     */
    public Connection getConnection();

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

    /**
     * getScriptlet.
     *
     * @param name a {@link java.lang.String} object.
     * @return a {@link net.sf.dynamicreports.report.definition.DRIScriptlet} object.
     */
    public DRIScriptlet getScriptlet(String name);

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

    /**
     * getMessage.
     *
     * @param key       a {@link java.lang.String} object.
     * @param arguments an array of {@link java.lang.Object} objects.
     * @return a {@link java.lang.String} object.
     */
    public String getMessage(String key, Object[] arguments);

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

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