net.sf.jasperreports.engine.fill.AsynchronousFillHandle Maven / Gradle / Ivy
/*
* 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
* An instance of this type can be used as a handle to an asychronous fill process.
* The main benefit of this method is that the filling process can be cancelled.
*
* @author Lucian Chirita ([email protected])
*/
public class AsynchronousFillHandle extends BaseFillHandle
{
/**
* A property that determines whether a report can be generated and displayed asynchronously in a viewer.
*
* Asynchronous report generation implies displaying report pages before the report is complete.
*/
// TODO lucianc use in web viewer
@Property(
category = PropertyConstants.CATEGORY_FILL,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_4_6_0,
valueType = Boolean.class,
defaultValue = PropertyConstants.BOOLEAN_TRUE
)
public static final String PROPERTY_REPORT_ASYNC = JRPropertiesUtil.PROPERTY_PREFIX + "viewer.async";
protected Thread fillThread;
protected Integer priority;
protected String threadName;
protected AsynchronousFillHandle (
JasperReportsContext jasperReportsContext,
JasperReport jasperReport,
Map parameters,
JRDataSource dataSource
) throws JRException
{
this(jasperReportsContext, jasperReport, parameters, dataSource, null);
}
protected AsynchronousFillHandle (
JasperReportsContext jasperReportsContext,
JasperReport jasperReport,
Map parameters,
Connection conn
) throws JRException
{
this(jasperReportsContext, jasperReport, parameters, null, conn);
}
protected AsynchronousFillHandle (
JasperReportsContext jasperReportsContext,
JasperReport jasperReport,
Map parameters
) throws JRException
{
this(jasperReportsContext, jasperReport, parameters, null, null);
}
protected AsynchronousFillHandle (
JasperReportsContext jasperReportsContext,
JasperReport jasperReport,
Map parameters,
JRDataSource dataSource,
Connection conn
) throws JRException
{
this(jasperReportsContext, SimpleJasperReportSource.from(jasperReport),
parameters, dataSource, conn);
}
protected AsynchronousFillHandle (
JasperReportsContext jasperReportsContext,
JasperReportSource reportSource,
Map parameters,
JRDataSource dataSource,
Connection conn
) throws JRException
{
super(jasperReportsContext, reportSource, parameters, dataSource, conn);
}
/**
* Returns an executor that creates a new thread to perform the report execution.
*/
@Override
protected Executor getReportExecutor()
{
return new ThreadExecutor();
}
protected class ThreadExecutor implements Executor
{
@Override
public void execute(Runnable command)
{
if (threadName == null)
{
fillThread = new Thread(command);
}
else
{
fillThread = new Thread(command, threadName);
}
if (priority != null)
{
fillThread.setPriority(priority);
}
fillThread.start();
}
}
/**
* Creates an asychronous filling handle.
*
* @param jasperReportsContext the context
* @param jasperReport the report
* @param parameters the parameter map
* @param dataSource the data source
* @return the handle
* @throws JRException
*/
public static AsynchronousFillHandle createHandle(
JasperReportsContext jasperReportsContext,
JasperReport jasperReport,
Map parameters,
JRDataSource dataSource
) throws JRException
{
return createHandle(jasperReportsContext, SimpleJasperReportSource.from(jasperReport),
parameters, dataSource);
}
public static AsynchronousFillHandle createHandle(
JasperReportsContext jasperReportsContext,
JasperReportSource reportSource,
Map parameters,
JRDataSource dataSource
) throws JRException
{
return new AsynchronousFillHandle(jasperReportsContext, reportSource, parameters, dataSource, null);
}
/**
* Creates an asychronous filling handle.
*
* @param jasperReportsContext the context
* @param jasperReport the report
* @param parameters the parameter map
* @param conn the connection
* @return the handle
* @throws JRException
*/
public static AsynchronousFillHandle createHandle(
JasperReportsContext jasperReportsContext,
JasperReport jasperReport,
Map parameters,
Connection conn
) throws JRException
{
return createHandle(jasperReportsContext, SimpleJasperReportSource.from(jasperReport),
parameters, conn);
}
public static AsynchronousFillHandle createHandle(
JasperReportsContext jasperReportsContext,
JasperReportSource reportSource,
Map parameters,
Connection conn
) throws JRException
{
return new AsynchronousFillHandle(jasperReportsContext, reportSource, parameters, null, conn);
}
/**
* Creates an asychronous filling handle.
*
* @param jasperReportsContext the context
* @param jasperReport the report
* @param parameters the parameter map
* @return the handle
* @throws JRException
*/
public static AsynchronousFillHandle createHandle(
JasperReportsContext jasperReportsContext,
JasperReport jasperReport,
Map parameters
) throws JRException
{
return createHandle(jasperReportsContext, SimpleJasperReportSource.from(jasperReport), parameters);
}
public static AsynchronousFillHandle createHandle(
JasperReportsContext jasperReportsContext,
JasperReportSource reportSource,
Map parameters
) throws JRException
{
return new AsynchronousFillHandle(jasperReportsContext, reportSource, parameters, null, null);
}
/**
* @see #createHandle(JasperReportsContext, JasperReport, Map, JRDataSource)
*/
public static AsynchronousFillHandle createHandle(
JasperReport jasperReport,
Map parameters,
JRDataSource dataSource
) throws JRException
{
return createHandle(DefaultJasperReportsContext.getInstance(), jasperReport, parameters, dataSource);
}
/**
* @see #createHandle(JasperReportsContext, JasperReport, Map, Connection)
*/
public static AsynchronousFillHandle createHandle(
JasperReport jasperReport,
Map parameters,
Connection conn
) throws JRException
{
return createHandle(DefaultJasperReportsContext.getInstance(), jasperReport, parameters, conn);
}
/**
* @see #createHandle(JasperReportsContext, JasperReport, Map)
*/
public static AsynchronousFillHandle createHandle(
JasperReport jasperReport,
Map parameters
) throws JRException
{
return createHandle(DefaultJasperReportsContext.getInstance(), jasperReport, parameters);
}
/**
* Sets the priority of the filler thread.
*
* @param priority the filler thread priority.
* @see Thread#setPriority(int)
*/
public void setPriority (int priority)
{
synchronized (lock)
{
this.priority = priority;
if (fillThread != null)
{
fillThread.setPriority(priority);
}
}
}
/**
* Sets the name of the filler thread.
*
* @param name the filler thread name.
* @see Thread#setName(java.lang.String)
*/
public void setThreadName (String name)
{
synchronized (lock)
{
this.threadName = name;
if (fillThread != null)
{
fillThread.setName(name);
}
}
}
}