net.sf.jasperreports.engine.fill.JRRecordedValues Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 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 .
*/
package net.sf.jasperreports.engine.fill;
import java.io.Serializable;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.type.EvaluationTimeEnum;
/**
* Recorded values container used by elements with
* {@link EvaluationTimeEnum#AUTO Auto evaluation time}.
*
* @author Lucian Chirita ([email protected])
*/
public class JRRecordedValues implements Serializable
{
/**
*
*/
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
private Set evaluationTimes;
private Map recordedVariableValues;
private Map recordedFieldValues;
/**
* Creates a recorded values set.
*
* @param evaluationTimes future times when the values will be recorded
*/
public JRRecordedValues(Set evaluationTimes)
{
this.evaluationTimes = new HashSet(evaluationTimes);
}
public JRRecordedValues(Set evaluationTimes,
Map recordedFieldValues,
Map recordedVariableValues)
{
this.evaluationTimes = evaluationTimes;
this.recordedFieldValues = recordedFieldValues;
this.recordedVariableValues = recordedVariableValues;
}
public Set getEvaluationTimes()
{
return evaluationTimes;
}
/**
* Marks an evaluation time as done.
*
* @param evaluationTime the evaluation time
*/
public void doneEvaluation(JREvaluationTime evaluationTime)
{
evaluationTimes.remove(evaluationTime);
}
/**
* Decides whether this is the last evaluation time.
*
* @return whether this is the last evaluation time
*/
public boolean lastEvaluationTime()
{
return evaluationTimes.size() == 1;
}
/**
* Decides whether all required evaluations are done.
*
* @return whether all required evaluations are done
*/
public boolean finishedEvaluations()
{
return evaluationTimes.isEmpty();
}
/**
* Records a variable value.
*
* @param variableName the variable name
* @param value the variable value to record
*/
public void recordVariableValue(String variableName, Object value)
{
if (recordedVariableValues == null)
{
recordedVariableValues = new HashMap();
}
recordedVariableValues.put(variableName, value);
}
/**
* Records a field value.
*
* @param fieldName the field name
* @param value the field value to record
*/
public void recordFieldValue(String fieldName, Object value)
{
if (recordedFieldValues == null)
{
recordedFieldValues = new HashMap();
}
recordedFieldValues.put(fieldName, value);
}
/**
* Returns the recorded variable values indexed by variable name.
*
* @return the recorded variable values
*/
public Map getRecordedVariableValues()
{
return recordedVariableValues;
}
/**
* Returns the recorded field values indexed by field name.
*
* @return the recorded field values
*/
public Map getRecordedFieldValues()
{
return recordedFieldValues;
}
}