diff --git a/spring-context-support/src/main/java/org/springframework/ui/jasperreports/JasperReportsUtils.java b/spring-context-support/src/main/java/org/springframework/ui/jasperreports/JasperReportsUtils.java index 591f2a6fac6..29ac1ee0f7b 100644 --- a/spring-context-support/src/main/java/org/springframework/ui/jasperreports/JasperReportsUtils.java +++ b/spring-context-support/src/main/java/org/springframework/ui/jasperreports/JasperReportsUtils.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2012 the original author or authors. + * Copyright 2002-2014 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,15 +23,12 @@ import java.util.Map; import net.sf.jasperreports.engine.JRDataSource; import net.sf.jasperreports.engine.JRException; -import net.sf.jasperreports.engine.JRExporter; -import net.sf.jasperreports.engine.JRExporterParameter; import net.sf.jasperreports.engine.JasperFillManager; import net.sf.jasperreports.engine.JasperPrint; import net.sf.jasperreports.engine.JasperReport; import net.sf.jasperreports.engine.data.JRBeanArrayDataSource; import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource; import net.sf.jasperreports.engine.export.JRCsvExporter; -import net.sf.jasperreports.engine.export.JRHtmlExporter; import net.sf.jasperreports.engine.export.JRPdfExporter; import net.sf.jasperreports.engine.export.JRXlsExporter; @@ -39,10 +36,15 @@ import net.sf.jasperreports.engine.export.JRXlsExporter; * Utility methods for working with JasperReports. Provides a set of convenience * methods for generating reports in a CSV, HTML, PDF and XLS formats. * + *
This class is compatible with classic JasperReports releases back until 2.x.
+ * As a consequence, it keeps using the {@link net.sf.jasperreports.engine.JRExporter}
+ * API which has been deprecated in early 2014.
+ *
* @author Rob Harrop
* @author Juergen Hoeller
* @since 1.1.3
*/
+@SuppressWarnings({"deprecation", "rawtypes"})
public abstract class JasperReportsUtils {
/**
@@ -84,11 +86,11 @@ public abstract class JasperReportsUtils {
* @param writer the {@code Writer} to write the result to
* @throws JRException if rendering failed
*/
- public static void render(JRExporter exporter, JasperPrint print, Writer writer)
+ public static void render(net.sf.jasperreports.engine.JRExporter exporter, JasperPrint print, Writer writer)
throws JRException {
- exporter.setParameter(JRExporterParameter.JASPER_PRINT, print);
- exporter.setParameter(JRExporterParameter.OUTPUT_WRITER, writer);
+ exporter.setParameter(net.sf.jasperreports.engine.JRExporterParameter.JASPER_PRINT, print);
+ exporter.setParameter(net.sf.jasperreports.engine.JRExporterParameter.OUTPUT_WRITER, writer);
exporter.exportReport();
}
@@ -103,11 +105,11 @@ public abstract class JasperReportsUtils {
* @param outputStream the {@code OutputStream} to write the result to
* @throws JRException if rendering failed
*/
- public static void render(JRExporter exporter, JasperPrint print, OutputStream outputStream)
- throws JRException {
+ public static void render(net.sf.jasperreports.engine.JRExporter exporter, JasperPrint print,
+ OutputStream outputStream) throws JRException {
- exporter.setParameter(JRExporterParameter.JASPER_PRINT, print);
- exporter.setParameter(JRExporterParameter.OUTPUT_STREAM, outputStream);
+ exporter.setParameter(net.sf.jasperreports.engine.JRExporterParameter.JASPER_PRINT, print);
+ exporter.setParameter(net.sf.jasperreports.engine.JRExporterParameter.OUTPUT_STREAM, outputStream);
exporter.exportReport();
}
@@ -137,12 +139,13 @@ public abstract class JasperReportsUtils {
* @param writer the {@code Writer} to write the rendered report to
* @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array
* (converted accordingly), representing the report data to read fields from
- * @param exporterParameters a {@link Map} of {@link JRExporterParameter exporter parameters}
+ * @param exporterParameters a {@link Map} of {@code JRExporterParameter exporter parameters}
* @throws JRException if rendering failed
* @see #convertReportData
*/
public static void renderAsCsv(JasperReport report, Map This class is compatible with classic JasperReports releases back until 2.x.
+ * As a consequence, it keeps using the {@link net.sf.jasperreports.engine.JRExporter}
+ * API which got deprecated as of JasperReports 5.5.2 (early 2014).
+ *
* @author Rob Harrop
* @author Juergen Hoeller
* @since 1.1.5
* @see #createExporter()
* @see #useWriter()
*/
+@SuppressWarnings({"deprecation", "rawtypes"})
public abstract class AbstractJasperReportsSingleFormatView extends AbstractJasperReportsView {
@Override
@@ -54,12 +57,13 @@ public abstract class AbstractJasperReportsSingleFormatView extends AbstractJasp
* for a pre-defined output format.
*/
@Override
+ @SuppressWarnings("unchecked")
protected void renderReport(JasperPrint populatedReport, Map This class is compatible with classic JasperReports releases back until 2.x.
+ * As a consequence, it keeps using the {@link net.sf.jasperreports.engine.JRExporter}
+ * API which got deprecated as of JasperReports 5.5.2 (early 2014).
+ *
* @author Rob Harrop
* @author Juergen Hoeller
* @since 1.1.3
@@ -112,6 +115,7 @@ import org.springframework.web.servlet.view.AbstractUrlBasedView;
* @see #setExporterParameters
* @see #setJdbcDataSource
*/
+@SuppressWarnings({"deprecation", "rawtypes"})
public abstract class AbstractJasperReportsView extends AbstractUrlBasedView {
/**
@@ -157,7 +161,7 @@ public abstract class AbstractJasperReportsView extends AbstractUrlBasedView {
/**
* Stores the converted exporter parameters - keyed by {@code JRExporterParameter}.
*/
- private Map The default implementation simply converts the String values "true" and
* "false" into corresponding {@code Boolean} objects, and tries to convert
* String values that start with a digit into {@code Integer} objects
@@ -373,7 +378,7 @@ public abstract class AbstractJasperReportsView extends AbstractUrlBasedView {
* @param value the parameter value
* @return the converted parameter value
*/
- protected Object convertParameterValue(JRExporterParameter parameter, Object value) {
+ protected Object convertParameterValue(net.sf.jasperreports.engine.JRExporterParameter parameter, Object value) {
if (value instanceof String) {
String str = (String) value;
if ("true".equals(str)) {
@@ -403,9 +408,9 @@ public abstract class AbstractJasperReportsView extends AbstractUrlBasedView {
* @return a JRExporterParameter for the given parameter object
* @see #convertToExporterParameter(String)
*/
- protected JRExporterParameter getExporterParameter(Object parameter) {
- if (parameter instanceof JRExporterParameter) {
- return (JRExporterParameter) parameter;
+ protected net.sf.jasperreports.engine.JRExporterParameter getExporterParameter(Object parameter) {
+ if (parameter instanceof net.sf.jasperreports.engine.JRExporterParameter) {
+ return (net.sf.jasperreports.engine.JRExporterParameter) parameter;
}
if (parameter instanceof String) {
return convertToExporterParameter((String) parameter);
@@ -422,7 +427,7 @@ public abstract class AbstractJasperReportsView extends AbstractUrlBasedView {
* (e.g. "net.sf.jasperreports.engine.export.JRHtmlExporterParameter.IMAGES_URI")
* @return the corresponding JRExporterParameter instance
*/
- protected JRExporterParameter convertToExporterParameter(String fqFieldName) {
+ protected net.sf.jasperreports.engine.JRExporterParameter convertToExporterParameter(String fqFieldName) {
int index = fqFieldName.lastIndexOf('.');
if (index == -1 || index == fqFieldName.length()) {
throw new IllegalArgumentException(
@@ -437,9 +442,9 @@ public abstract class AbstractJasperReportsView extends AbstractUrlBasedView {
Class> cls = ClassUtils.forName(className, getApplicationContext().getClassLoader());
Field field = cls.getField(fieldName);
- if (JRExporterParameter.class.isAssignableFrom(field.getType())) {
+ if (net.sf.jasperreports.engine.JRExporterParameter.class.isAssignableFrom(field.getType())) {
try {
- return (JRExporterParameter) field.get(null);
+ return (net.sf.jasperreports.engine.JRExporterParameter) field.get(null);
}
catch (IllegalAccessException ex) {
throw new IllegalArgumentException(
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/ConfigurableJasperReportsView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/ConfigurableJasperReportsView.java
index f2a579bef68..ab1c67e721d 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/ConfigurableJasperReportsView.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/ConfigurableJasperReportsView.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,8 +16,6 @@
package org.springframework.web.servlet.view.jasperreports;
-import net.sf.jasperreports.engine.JRExporter;
-
import org.springframework.beans.BeanUtils;
import org.springframework.util.Assert;
@@ -25,6 +23,10 @@ import org.springframework.util.Assert;
* Configurable JasperReports View, allowing to specify the JasperReports exporter
* to be specified through bean properties rather than through the view class name.
*
+ * This class is compatible with classic JasperReports releases back until 2.x.
+ * As a consequence, it keeps using the {@link net.sf.jasperreports.engine.JRExporter}
+ * API which got deprecated as of JasperReports 5.5.2 (early 2014).
+ *
* @author Rob Harrop
* @since 2.0
* @see JasperReportsCsvView
@@ -32,25 +34,26 @@ import org.springframework.util.Assert;
* @see JasperReportsPdfView
* @see JasperReportsXlsView
*/
+@SuppressWarnings({"deprecation", "rawtypes"})
public class ConfigurableJasperReportsView extends AbstractJasperReportsSingleFormatView {
- private Class extends JRExporter> exporterClass;
+ private Class extends net.sf.jasperreports.engine.JRExporter> exporterClass;
private boolean useWriter = true;
/**
- * Set the {@link JRExporter} implementation {@code Class} to use. Throws
+ * Set the {@code JRExporter} implementation {@code Class} to use. Throws
* {@link IllegalArgumentException} if the {@code Class} doesn't implement
- * {@link JRExporter}. Required setting, as it does not have a default.
+ * {@code JRExporter}. Required setting, as it does not have a default.
*/
- public void setExporterClass(Class extends JRExporter> exporterClass) {
- Assert.isAssignable(JRExporter.class, exporterClass);
+ public void setExporterClass(Class extends net.sf.jasperreports.engine.JRExporter> exporterClass) {
+ Assert.isAssignable(net.sf.jasperreports.engine.JRExporter.class, exporterClass);
this.exporterClass = exporterClass;
}
/**
- * Specifies whether or not the {@link JRExporter} writes to the {@link java.io.PrintWriter}
+ * Specifies whether or not the {@code JRExporter} writes to the {@link java.io.PrintWriter}
* of the associated with the request ({@code true}) or whether it writes directly to the
* {@link java.io.InputStream} of the request ({@code false}). Default is {@code true}.
*/
@@ -70,17 +73,17 @@ public class ConfigurableJasperReportsView extends AbstractJasperReportsSingleFo
/**
- * Returns a new instance of the specified {@link JRExporter} class.
+ * Returns a new instance of the specified {@link net.sf.jasperreports.engine.JRExporter} class.
* @see #setExporterClass(Class)
* @see BeanUtils#instantiateClass(Class)
*/
@Override
- protected JRExporter createExporter() {
+ protected net.sf.jasperreports.engine.JRExporter createExporter() {
return BeanUtils.instantiateClass(this.exporterClass);
}
/**
- * Indicates how the {@link JRExporter} should render its data.
+ * Indicates how the {@code JRExporter} should render its data.
* @see #setUseWriter(boolean)
*/
@Override
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsCsvView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsCsvView.java
index b93a28269be..c175d8860c2 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsCsvView.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsCsvView.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,17 +16,21 @@
package org.springframework.web.servlet.view.jasperreports;
-import net.sf.jasperreports.engine.JRExporter;
import net.sf.jasperreports.engine.export.JRCsvExporter;
/**
* Implementation of {@code AbstractJasperReportsSingleFormatView}
* that renders report results in CSV format.
*
+ * This class is compatible with classic JasperReports releases back until 2.x.
+ * As a consequence, it keeps using the {@link net.sf.jasperreports.engine.JRExporter}
+ * API which got deprecated as of JasperReports 5.5.2 (early 2014).
+ *
* @author Rob Harrop
* @author Juergen Hoeller
* @since 1.1.3
*/
+@SuppressWarnings({"deprecation", "rawtypes"})
public class JasperReportsCsvView extends AbstractJasperReportsSingleFormatView {
public JasperReportsCsvView() {
@@ -34,7 +38,7 @@ public class JasperReportsCsvView extends AbstractJasperReportsSingleFormatView
}
@Override
- protected JRExporter createExporter() {
+ protected net.sf.jasperreports.engine.JRExporter createExporter() {
return new JRCsvExporter();
}
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsHtmlView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsHtmlView.java
index 83ac59115c2..5ba04aa064b 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsHtmlView.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsHtmlView.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,17 +16,19 @@
package org.springframework.web.servlet.view.jasperreports;
-import net.sf.jasperreports.engine.JRExporter;
-import net.sf.jasperreports.engine.export.JRHtmlExporter;
-
/**
* Implementation of {@code AbstractJasperReportsSingleFormatView}
* that renders report results in HTML format.
*
+ * This class is compatible with classic JasperReports releases back until 2.x.
+ * As a consequence, it keeps using the {@link net.sf.jasperreports.engine.JRExporter}
+ * API which got deprecated as of JasperReports 5.5.2 (early 2014).
+ *
* @author Rob Harrop
* @author Juergen Hoeller
* @since 1.1.3
*/
+@SuppressWarnings({"deprecation", "rawtypes"})
public class JasperReportsHtmlView extends AbstractJasperReportsSingleFormatView {
public JasperReportsHtmlView() {
@@ -34,8 +36,8 @@ public class JasperReportsHtmlView extends AbstractJasperReportsSingleFormatView
}
@Override
- protected JRExporter createExporter() {
- return new JRHtmlExporter();
+ protected net.sf.jasperreports.engine.JRExporter createExporter() {
+ return new net.sf.jasperreports.engine.export.JRHtmlExporter();
}
@Override
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsPdfView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsPdfView.java
index f10937f2e21..b5c86129b9f 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsPdfView.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsPdfView.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,17 +16,21 @@
package org.springframework.web.servlet.view.jasperreports;
-import net.sf.jasperreports.engine.JRExporter;
import net.sf.jasperreports.engine.export.JRPdfExporter;
/**
* Implementation of {@code AbstractJasperReportsSingleFormatView}
* that renders report results in PDF format.
*
+ * This class is compatible with classic JasperReports releases back until 2.x.
+ * As a consequence, it keeps using the {@link net.sf.jasperreports.engine.JRExporter}
+ * API which got deprecated as of JasperReports 5.5.2 (early 2014).
+ *
* @author Rob Harrop
* @author Juergen Hoeller
* @since 1.1.3
*/
+@SuppressWarnings({"deprecation", "rawtypes"})
public class JasperReportsPdfView extends AbstractJasperReportsSingleFormatView {
public JasperReportsPdfView() {
@@ -34,7 +38,7 @@ public class JasperReportsPdfView extends AbstractJasperReportsSingleFormatView
}
@Override
- protected JRExporter createExporter() {
+ protected net.sf.jasperreports.engine.JRExporter createExporter() {
return new JRPdfExporter();
}
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsXlsView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsXlsView.java
index 33ae346f0a0..7e3def0a736 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsXlsView.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/jasperreports/JasperReportsXlsView.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -16,17 +16,21 @@
package org.springframework.web.servlet.view.jasperreports;
-import net.sf.jasperreports.engine.JRExporter;
import net.sf.jasperreports.engine.export.JRXlsExporter;
/**
* Implementation of {@code AbstractJasperReportsSingleFormatView}
* that renders report results in XLS format.
*
+ * This class is compatible with classic JasperReports releases back until 2.x.
+ * As a consequence, it keeps using the {@link net.sf.jasperreports.engine.JRExporter}
+ * API which got deprecated as of JasperReports 5.5.2 (early 2014).
+ *
* @author Rob Harrop
* @author Juergen Hoeller
* @since 1.1.3
*/
+@SuppressWarnings({"deprecation", "rawtypes"})
public class JasperReportsXlsView extends AbstractJasperReportsSingleFormatView {
public JasperReportsXlsView() {
@@ -34,7 +38,7 @@ public class JasperReportsXlsView extends AbstractJasperReportsSingleFormatView
}
@Override
- protected JRExporter createExporter() {
+ protected net.sf.jasperreports.engine.JRExporter createExporter() {
return new JRXlsExporter();
}