net.sf.jasperreports.customvisualization.xml.CVXmlWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports-custom-visualization Show documentation
JasperReports Custom Visualization Component
There is a newer version: 6.21.4
Show newest version
/*
 * 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.customvisualization.xml;

import java.io.IOException;
import java.util.List;

import net.sf.jasperreports.components.AbstractComponentXmlWriter;
import net.sf.jasperreports.components.items.Item;
import net.sf.jasperreports.components.items.ItemData;
import net.sf.jasperreports.components.items.ItemProperty;
import net.sf.jasperreports.customvisualization.CVComponent;
import net.sf.jasperreports.customvisualization.CVConstants;
import net.sf.jasperreports.engine.JRComponentElement;
import net.sf.jasperreports.engine.JRElementDataset;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.component.Component;
import net.sf.jasperreports.engine.component.ComponentKey;
import net.sf.jasperreports.engine.type.EvaluationTimeEnum;
import net.sf.jasperreports.engine.type.OnErrorTypeEnum;
import net.sf.jasperreports.engine.util.JRXmlWriteHelper;
import net.sf.jasperreports.engine.util.XmlNamespace;
import net.sf.jasperreports.engine.xml.JRXmlConstants;
import net.sf.jasperreports.engine.xml.JRXmlWriter;

/**
 *
 * @author Giulio Toffoli ([email protected])
 */
public class CVXmlWriter extends AbstractComponentXmlWriter
{

	public CVXmlWriter(JasperReportsContext jasperReportsContext)
	{
		super(jasperReportsContext);
	}

	public void writeCV(JRComponentElement componentElement, JRXmlWriter reportWriter) throws IOException
	{

		Component component = componentElement.getComponent();
		CVComponent comp = (CVComponent) component;
		JRXmlWriteHelper writer = reportWriter.getXmlWriteHelper();
		ComponentKey componentKey = componentElement.getComponentKey();

		XmlNamespace namespace = 
			new XmlNamespace(
				CVConstants.NAMESPACE,
				componentKey.getNamespacePrefix(),
				CVConstants.XSD_LOCATION
				);

		writer.startElement("customvisualization", namespace);

		writer.addAttribute(JRXmlConstants.ATTRIBUTE_evaluationTime, comp.getEvaluationTime(), EvaluationTimeEnum.NOW);

		if (comp.getEvaluationGroup() != null && comp.getEvaluationGroup().trim().length() > 0)
		{
			writer.addAttribute(JRXmlConstants.ATTRIBUTE_evaluationGroup, comp.getEvaluationGroup());
		}

		writer.addAttribute(CVXmlFactory.ATTRIBUTE_processingClass, comp.getProcessingClass());

		writer.addAttribute(CVXmlFactory.ATTRIBUTE_onErrorType, comp.getOnErrorType(), OnErrorTypeEnum.ERROR);

		List itemProperties = comp.getItemProperties();
		for (ItemProperty itemProperty : itemProperties)
		{
			writeCVItemProperty(itemProperty, writer, reportWriter, namespace, componentElement);
		}

		List itemDataList = comp.getItemData();
		for (ItemData itemData : itemDataList)
		{
			if (itemData == null)
			{
				continue;
			}
			writeItemDataset(itemData, writer, reportWriter, namespace, componentElement);
		}

		writer.closeElement();
	}

	private void writeCVItemProperty(
		ItemProperty itemProperty, 
		JRXmlWriteHelper writer, 
		JRXmlWriter reportWriter,
		XmlNamespace namespace, 
		JRComponentElement componentElement
		) throws IOException
	{
		writer.startElement(CVXmlFactory.ELEMENT_itemProperty, namespace);

		writer.addAttribute(JRXmlConstants.ATTRIBUTE_name, itemProperty.getName());
		if (itemProperty.getValue() != null)
		{
			writer.addAttribute(JRXmlConstants.ATTRIBUTE_value, itemProperty.getValue());
		}
		writeExpression(
			JRXmlConstants.ELEMENT_valueExpression,
			JRXmlWriter.JASPERREPORTS_NAMESPACE,
			itemProperty.getValueExpression(), 
			false, 
			componentElement, 
			reportWriter
			);
		writer.closeElement();
	}

	private void writeItemDataset(
		ItemData itemDataset, 
		JRXmlWriteHelper writer, 
		JRXmlWriter reportWriter,
		XmlNamespace namespace, 
		JRComponentElement componentElement
		) throws IOException
	{
		writer.startElement(CVXmlFactory.ELEMENT_cvData, namespace);

		JRElementDataset dataset = itemDataset.getDataset();
		if (dataset != null)
		{
			reportWriter.writeElementDataset(dataset, false);
		}

		/*   */
		List itemList = itemDataset.getItems();
		if (itemList != null && !itemList.isEmpty())
		{

			for (Item item : itemList)
			{
				writer.startElement(CVXmlFactory.ELEMENT_item, namespace);
				if (item.getProperties() != null && !item.getProperties().isEmpty())
				{
					for (ItemProperty itemProperty : item.getProperties())
					{
						if (itemProperty == null)
						{
							continue;
						}
						writeCVItemProperty(itemProperty, writer, reportWriter, namespace, componentElement);
					}
				}
				writer.closeElement();
			}

		}

		writer.closeElement();
	}

	@Override
	public boolean isToWrite(JRComponentElement jrce, JRXmlWriter writer)
	{
		return true;
	}

	@Override
	public void writeToXml(JRComponentElement componentElement, JRXmlWriter reportWriter) throws IOException
	{
		Component component = componentElement.getComponent();
		if (component instanceof CVComponent)
		{
			writeCV(componentElement, reportWriter);
		}
	}

}