net.sf.jasperreports.engine.util.JRQueryExecuterUtils Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2013 Jaspersoft Corporation. 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.util;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import net.sf.jasperreports.engine.DefaultJasperReportsContext;
import net.sf.jasperreports.engine.JRDataset;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRRuntimeException;
import net.sf.jasperreports.engine.JRValueParameter;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.query.JRQueryExecuter;
import net.sf.jasperreports.engine.query.JRQueryExecuterFactory;
import net.sf.jasperreports.engine.query.JRQueryExecuterFactoryBundle;
import net.sf.jasperreports.engine.query.QueryExecuterFactory;
import net.sf.jasperreports.engine.query.QueryExecuterFactoryBundle;
/**
* Query executer utility class.
*
* @author Lucian Chirita ([email protected])
* @version $Id: JRQueryExecuterUtils.java 5878 2013-01-07 20:23:13Z teodord $
*/
@SuppressWarnings("deprecation")
public final class JRQueryExecuterUtils
{
private JasperReportsContext jasperReportsContext;
/**
*
*/
private JRQueryExecuterUtils(JasperReportsContext jasperReportsContext)
{
this.jasperReportsContext = jasperReportsContext;
}
/**
*
*/
private static JRQueryExecuterUtils getDefaultInstance()
{
return new JRQueryExecuterUtils(DefaultJasperReportsContext.getInstance());
}
/**
*
*/
public static JRQueryExecuterUtils getInstance(JasperReportsContext jasperReportsContext)
{
return new JRQueryExecuterUtils(jasperReportsContext);
}
/**
* Returns a query executer factory for a query language.
*
* @param language the query language
* @return a query executer factory
* @throws JRException
* @see QueryExecuterFactory#QUERY_EXECUTER_FACTORY_PREFIX
*/
public QueryExecuterFactory getExecuterFactory(String language) throws JRException
{
List oldBundles = jasperReportsContext.getExtensions(
QueryExecuterFactoryBundle.class);
for (Iterator it = oldBundles.iterator(); it.hasNext();)
{
QueryExecuterFactoryBundle bundle = it.next();
JRQueryExecuterFactory factory = bundle.getQueryExecuterFactory(language);
if (factory != null)
{
return new WrappingQueryExecuterFactory(factory);
}
}
List bundles = jasperReportsContext.getExtensions(
JRQueryExecuterFactoryBundle.class);
for (Iterator it = bundles.iterator(); it.hasNext();)
{
JRQueryExecuterFactoryBundle bundle = it.next();
QueryExecuterFactory factory = bundle.getQueryExecuterFactory(language);
if (factory != null)
{
return factory;
}
}
throw new JRRuntimeException("No query executer factory registered for the '" + language + "' language.");
}
/**
* Returns a query executer factory for a query language.
*
* @param language the query language
* @return a query executer factory
* @throws JRException
* @see JRProperties#QUERY_EXECUTER_FACTORY_PREFIX
* @deprecated Replaced by {@link #getExecuterFactory(String)}.
*/
public static JRQueryExecuterFactory getQueryExecuterFactory(String language) throws JRException
{
return getDefaultInstance().getExecuterFactory(language);
}
/**
* @deprecated To be removed.
*/
public static class WrappingQueryExecuterFactory implements QueryExecuterFactory
{
private JRQueryExecuterFactory factory;
public WrappingQueryExecuterFactory(JRQueryExecuterFactory factory)
{
this.factory = factory;
}
public Object[] getBuiltinParameters()
{
return factory.getBuiltinParameters();
}
public JRQueryExecuter createQueryExecuter(
JasperReportsContext jasperReportsContext,
JRDataset dataset,
Map parameters
) throws JRException
{
return factory.createQueryExecuter(dataset, parameters);
}
public JRQueryExecuter createQueryExecuter(
JRDataset dataset,
Map parameters
) throws JRException
{
return factory.createQueryExecuter(dataset, parameters);
}
public boolean supportsQueryParameterType(String className)
{
return factory.supportsQueryParameterType(className);
}
}
}