net.sf.jasperreports.engine.JRDataset Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2016 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports 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.
*
* JasperReports 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 JasperReports. If not, see Main Dataset
* The report data source, along with the parameters, fields, variables, and groups declared
* at the report level, represent the building blocks of the main dataset for the report. All
* report templates implicitly declare and use this main dataset.
*
* The main dataset is responsible for iterating through the data source records, calculating
* variables, filtering out records, and estimating group breaks during the report-filling
* process.
*
* A report has one main dataset and multiple subdatasets that can be instantiated by charts, crosstabs
* and other components.
* Subdatasets
* User-defined datasets (or subdatasets) are declared in JRXML using the
* <subDataset> tag.
*
* The engine does not necessarily use a subdataset, once defined in the report. Subdatasets are
* instantiated and iterate through the supplied data source to calculate dataset variable values
* only if they are referenced by a chart, crosstab or other component's dataset run.
*
* Just like subreports, datasets, when instantiated, expect to receive parameter values and a
* data source to iterate through. As a convenience, datasets can have an associated SQL
* query that is executed by the engine if a java.sql.Connection object is supplied to
* them instead of the usual data source.
*
* Datasets can also have scriptlets associated with them to allow making callbacks to userdefined
* business logic during the dataset iteration, if further data manipulation is needed.
*
* @see net.sf.jasperreports.engine.JRDatasetRun
* @see net.sf.jasperreports.engine.JRReport#getMainDataset()
* @see net.sf.jasperreports.engine.JRReport#getDatasets()
* @author Lucian Chirita ([email protected])
*/
public interface JRDataset extends JRPropertiesHolder, JRCloneable, JRIdentifiable
{
/**
* Returns the dataset name.
*
* @return the name of the dataset
*/
public String getName();
/**
* The name of the scriptlet class to be used when iterating this dataset.
*
* @return the scriplet class name
*/
public String getScriptletClass();
/**
* Returns the dataset's scriptlets.
*
* @return the dataset's scriptlets
*/
public JRScriptlet[] getScriptlets();
/**
* Returns the list of dynamic/expression-based properties for this dataset.
*
* @return an array containing the expression-based properties of this dataset
*/
public DatasetPropertyExpression[] getPropertyExpressions();
/**
* Returns the dataset's parameters.
*
* @return the dataset's parameters
*/
public JRParameter[] getParameters();
/**
* Returns the query of the dataset.
*
* The query is used by passing a connection is passed to the dataset when instantiating.
*
* @return the query of the dataset
*/
public JRQuery getQuery();
/**
* Returns the dataset's fields.
*
* @return the dataset's fields
*/
public JRField[] getFields();
/**
* Returns the dataset's sort fields.
*
* @return the dataset's sort fields
*/
public JRSortField[] getSortFields();
/**
* Returns the dataset's variables.
*
* @return the dataset's variables
*/
public JRVariable[] getVariables();
/**
* Returns the dataset's groups.
*
* @return the dataset's groups
*/
public JRGroup[] getGroups();
/**
* Decides whether this dataset is the main report dataset or a sub dataset.
*
* @return true if and only if this dataset is the main report dataset
*/
public boolean isMainDataset();
/**
* Returns the resource bundle base name.
*
* The resource bundle is used when evaluating expressions.
*
* @return the resource bundle base name
*/
public String getResourceBundle();
/**
* Returns the resource missing handling type.
*
* @return the resource missing handling type
*/
public WhenResourceMissingTypeEnum getWhenResourceMissingTypeValue();
/**
* Sets the resource missing handling type.
* @param whenResourceMissingType the resource missing handling type
*/
public void setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType);
/**
* Returns the dataset filter expression.
*
* This expression is used to filter the rows of the
* {@link JRDataSource data source} that this dataset will iterate on.
*
*
* This expression (if not null) is evaluated immediately after a new row is
* {@link JRDataSource#next() produced} by the data source.
* The evaluation is performed using field and variable values corresponding to the new row.
* When the result of the evaluation is Boolean.TRUE the row gets processed by the report
* filling engine.
* When the result is null or Boolean.FALSE, the current row will be skipped and the datasource will be asked for the next row.
*
*
* @return the dataset filter expression
*/
public JRExpression getFilterExpression();
}