net.sf.jasperreports.parts.subreport.SubreportPartComponentCompiler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Free Java Reporting Library
There is a newer version: 6.21.2
/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2022 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.parts.subreport;

import net.sf.jasperreports.engine.JRExpressionCollector;
import net.sf.jasperreports.engine.JRSubreportParameter;
import net.sf.jasperreports.engine.JRSubreportReturnValue;
import net.sf.jasperreports.engine.base.JRBaseObjectFactory;
import net.sf.jasperreports.engine.design.JRVerifier;
import net.sf.jasperreports.engine.part.PartComponent;
import net.sf.jasperreports.engine.part.PartComponentCompiler;

/**
 * Compile-time handler of {@link SubreportPartComponent list component} instances.
 * 
 * @author Lucian Chirita ([email protected])
 */
public class SubreportPartComponentCompiler implements PartComponentCompiler
{

	@Override
	public void collectExpressions(PartComponent component, JRExpressionCollector collector)
	{
		SubreportPartComponent subreport = (SubreportPartComponent) component;
		
		collector.addExpression(subreport.getParametersMapExpression());
		
		JRSubreportParameter[] parameters = subreport.getParameters();
		if (parameters != null && parameters.length > 0)
		{
			for(int j = 0; j < parameters.length; j++)
			{
				collector.addExpression(parameters[j].getExpression());
			}
		}

		collector.addExpression(subreport.getExpression());
	}

	@Override
	public PartComponent toCompiledComponent(PartComponent component,
			JRBaseObjectFactory baseFactory)
	{
		SubreportPartComponent subreportComponent = (SubreportPartComponent) component;
		StandardSubreportPartComponent compiledComponent = new StandardSubreportPartComponent(
				subreportComponent, baseFactory);
		return compiledComponent;
	}

	@Override
	public void verify(PartComponent component, JRVerifier verifier)
	{
		// largely copied from JRVerifier.verifySubreport
		SubreportPartComponent subreportComponent = (SubreportPartComponent) component;
		JRSubreportParameter[] parameters = subreportComponent.getParameters();
		if (parameters != null && parameters.length > 0)
		{
			for(int index = 0; index < parameters.length; index++)
			{
				JRSubreportParameter parameter = parameters[index];

				if (parameter.getName() == null || parameter.getName().trim().length() == 0)
				{
					verifier.addBrokenRule("Subreport part parameter name missing.", parameter);
				}
			}
		}

		JRSubreportReturnValue[] returnValues = subreportComponent.getReturnValues();
		if (returnValues != null && returnValues.length > 0)
		{
			for (int i = 0; i < returnValues.length; i++)
			{
				JRSubreportReturnValue returnValue = returnValues[i];

				if (returnValue.getFromVariable() == null || returnValue.getFromVariable().trim().length() == 0)
				{
					verifier.addBrokenRule("Subreport part return value variable name missing.", returnValue);
				}

				if (returnValue.getToVariable() == null || returnValue.getToVariable().trim().length() == 0)
				{
					verifier.addBrokenRule("Subreport part return value to variable name missing.", returnValue);
				}

				if (!verifier.getReportDesign().getVariablesMap().containsKey(returnValue.getToVariable()))
				{
					verifier.addBrokenRule("Subreport part return value to variable not found.", returnValue);
				}
			}
		}
	}

}