net.sf.jasperreports.components.items.ItemData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation

JasperReports Library

There is a newer version: 7.0.0

/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2023 Cloud Software Group, 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 .
 */
package net.sf.jasperreports.components.items;

import java.util.List;

import net.sf.jasperreports.engine.JRCloneable;
import net.sf.jasperreports.engine.JRElementDataset;

/**
 * The ItemData interface
 * @author Teodor Danciu ([email protected])
 */
public interface ItemData extends JRCloneable
{

	/**
	 * Returns a list of {@link Item Item} 
	 * objects. Each item in the list provides a collection of item properties.
	 * 
	 * @return a list of items
	 * 
	 * @see Item
	 * @see ItemProperty
	 */
	public List getItems();
	
	/**
	 * Returns the dataset information that will be used by the {@link ItemData ItemData} object.
	 * 
	 * This information is required either to use the main dataset or to instantiate a 
	 * subdataset from the report. The data produced by the subdataset is fed to the items list.
	 * 
	 * @return the dataset
	 * @see net.sf.jasperreports.engine.JRElementDataset
	 */
	public JRElementDataset getDataset();

}