net.sf.jasperreports.engine.export.ElementPropertyExporterFilterFactory 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.3
/*
 * 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.engine.export;

import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRAbstractExporter;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.export.Exporter;
import net.sf.jasperreports.properties.PropertyConstants;

/**
 * 
 * @author Lucian Chirita ([email protected])
 */
public class ElementPropertyExporterFilterFactory implements ExporterFilterFactory
{

	/**
	 * The suffix of element exclusion properties.
	 * 
	 * This suffix is appended to the exporter properties prefix, resulting
	 * in element exclusion properties such as
	 * net.sf.jasperreports.export.xls.exclude. 
	 */
	@Property(
			name = "net.sf.jasperreports.export.{format}.exclude",
			category = PropertyConstants.CATEGORY_EXPORT,
			scopes = {PropertyScope.ELEMENT},
			valueType = Boolean.class,
			sinceVersion = PropertyConstants.VERSION_6_11_0
			)
	public static final String PROPERTY_EXCLUDE_SUFFIX = "exclude";
	
	/**
	 * Default element exclusion property.
	 */
	@Property(
			name = "net.sf.jasperreports.export.default.exclude",
			category = PropertyConstants.CATEGORY_EXPORT,
			scopes = {PropertyScope.ELEMENT},
			valueType = Boolean.class,
			defaultValue = "false",
			sinceVersion = PropertyConstants.VERSION_6_11_0
			)
	public static final String PROPERTY_DEFAULT_EXCLUDE = JRPropertiesUtil.PROPERTY_PREFIX + "export.default.exclude";

	@Override
	public ExporterFilter getFilter(JRExporterContext exporterContext)
			throws JRException
	{
		Exporter exporter = exporterContext.getExporterRef();
		if (!(exporter instanceof JRAbstractExporter))
		{
			return null;
		}
		
		String exporterPropertiesPrefix = ((JRAbstractExporter) exporter).getExporterPropertiesPrefix();
		String exportExcludeProperty = exporterPropertiesPrefix + PROPERTY_EXCLUDE_SUFFIX;
		ElementPropertyExporterFilter filter = new ElementPropertyExporterFilter(exportExcludeProperty);
		return filter;
	}

}