net.sf.jasperreports.engine.export.DefaultExporterFilterFactory 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.export;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JasperPrint;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Default exporter filter factory.
*
* The factory searches for all registered filter factories and collects all
* filters produced by these factories for a specific exporter context.
*
* @author Lucian Chirita ([email protected])
* @see #getFilter(JRExporterContext)
*/
public class DefaultExporterFilterFactory implements ExporterFilterFactory
{
/**
* The prefix of properties that are used to register filter factories.
*/
@Property(
name = "net.sf.jasperreports.export.filter.factory.{filter_element}",
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_3_0_1
)
public static final String PROPERTY_EXPORTER_FILTER_FACTORY_PREFIX =
JRPropertiesUtil.PROPERTY_PREFIX + "export.filter.factory.";
/**
* The method searches for all filter factories registered via
* {@link #PROPERTY_EXPORTER_FILTER_FACTORY_PREFIX net.sf.jasperreports.export.filter.factory.*} properties,
* calls each factory and collects the returned filters.
*
* The method returns:
*
* null
, if no factory returned a not null filter.
* - an individual filter, if a single factory returned a not null filter.
* - a {@link ExporterFilterContainer} instance, if several factories returned not null filters.
*
*
* @see #PROPERTY_EXPORTER_FILTER_FACTORY_PREFIX
*/
@Override
public ExporterFilter getFilter(JRExporterContext exporterContext) throws JRException
{
List factories = getAllFilterFactories(exporterContext.getJasperReportsContext(), exporterContext.getExportedReport());
List filters = new ArrayList(factories.size());
for (Iterator it = factories.iterator(); it.hasNext();)
{
ExporterFilterFactory factory = it.next();
ExporterFilter filter = factory.getFilter(exporterContext);
if (filter != null)
{
filters.add(filter);
}
}
ExporterFilter filter;
if (filters.isEmpty())
{
filter = null;
}
else if (filters.size() == 1)
{
filter = filters.get(0);
}
else
{
filter = new ExporterFilterContainer(filters);
}
return filter;
}
protected List getAllFilterFactories(JasperReportsContext jasperReportsContext, JasperPrint report) throws JRException
{
List factoryProps = JRPropertiesUtil.getInstance(jasperReportsContext).getAllProperties(report,
PROPERTY_EXPORTER_FILTER_FACTORY_PREFIX);
List factories = new ArrayList(factoryProps.size());
for (Iterator it = factoryProps.iterator(); it.hasNext();)
{
JRPropertiesUtil.PropertySuffix prop = it.next();
ExporterFilterFactory factory = getFilterFactory(prop.getValue());
factories.add(factory);
}
return factories;
}
protected ExporterFilterFactory getFilterFactory(String factoryClassName) throws JRException
{
return ExporterFilterFactoryUtil.getFilterFactory(factoryClassName);
}
}