net.sf.jasperreports.engine.fill.JRRecordedValuesPrintElement Maven / Gradle / Ivy
/*
* ============================================================================
* GNU Lesser General Public License
* ============================================================================
*
* JasperReports - Free Java report-generating library.
* Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*
* JasperSoft Corporation
* 303 Second Street, Suite 450 North
* San Francisco, CA 94107
* http://www.jaspersoft.com
*/
package net.sf.jasperreports.engine.fill;
import java.util.Set;
import net.sf.jasperreports.engine.JRPrintElement;
/**
* Interface implemented by print elements that can record field/variable values.
*
* An element having {@link net.sf.jasperreports.engine.JRExpression#EVALUATION_TIME_AUTO Auto evaluation time}
* will generate an instance of this type as print element.
* This instance will be responsible of storing field/variable values until the element can be evaluated.
*
* @author Lucian Chirita ([email protected])
* @version $Id: JRRecordedValuesPrintElement.java 1229 2006-04-19 10:27:35Z teodord $
* @see net.sf.jasperreports.engine.JRExpression#EVALUATION_TIME_AUTO
*/
public interface JRRecordedValuesPrintElement extends JRPrintElement
{
/**
* Initializes the recorded values set.
*
* @param evaluationTimes future times when the values will be recorded
*/
void initRecordedValues(Set evaluationTimes);
/**
* Returns the recorded values set.
*
* @return the recorded values set
*/
JRRecordedValues getRecordedValues();
/**
* Releases the recorded values set.
*
* This is called when all the recorded values are available and the element has been evaluated.
*/
void deleteRecordedValues();
}