JasperReport config

[gilbertoca]

Hi! (new user question)

I have one webapp configured and using InternalResourceViewResolver
. Now I want to use jasperreport:
How to config jasperreport using my InternalResourceViewResolver resolver (I need an example for jasperreport)?
Will I need to use the ResourceBundleViewResolver?

Thanks, Gilberto

[robh]

Gilberto,

You should read the JasperReports section in the Spring 1.1.3 reference guide.

Rob

[gilbertoca]

Yes! I've read that topic.

But I don't now how to put the jasperreport view resolver into my InternalResourceViewResolver:

   <!-- View Resolver for JSPs -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="requestContextAttribute"><value>rc</value></property>
        <property name="viewClass"><value>org.springframework.web.servlet.view.JstlView</value></property>
        <property name="prefix"><value>/WEB-INF/pages/</value></property>
        <property name="suffix"><value>.jsp</value></property>
    </bean>

My report is in: /WEB-INF/reports

Do I need to use the ResourceBundleViewResolver, because they are different views?

Thanks for help!

Gilberto

[gilbertoca]

Sore, I haven't used ResourceBundleViewResolver before! So, after I looked at the petclinic code I understood how it functions. And now I know I can put InternalResourceViewResolver and ResourceBundleViewResolver in the same xml config file.

So, for simple test I used your jasperreports test code in my SimpleReportControler:

I want map:
http://localhost:8080/estoque/simpleReport.html
to:
# Defines view with symbolic name "simpleReport"
simpleReport.class=org.springframework.web.servlet .view.jasperreports.JasperReportsPdfView
simpleReport.url=/WEB-INF/reports/DataSourceReport.jasper
in the views.properties file

public class SimpleReportController implements Controller {
...
 private Map getModel() {
        Map model = new HashMap();
        model.put("ReportTitle", "Dear Lord!");
        model.put("dataSource", new JRBeanCollectionDataSource(getData()));
        return model;
    }

    private List getData() {
        List list = new ArrayList();
        for &#40;int x = 0; x < 10; x++&#41; &#123;
            PersonBean bean = new PersonBean&#40;&#41;;
            bean.setId&#40;x&#41;;
            bean.setName&#40;"Rob Harrop"&#41;;
            bean.setStreet&#40;"foo"&#41;;
            list.add&#40;bean&#41;;
        &#125;
        return list;
    &#125;   
    public ModelAndView handleRequest&#40;HttpServletRequest request,
                                      HttpServletResponse response&#41;
    throws Exception &#123;
        if &#40;log.isDebugEnabled&#40;&#41;&#41; &#123;
            log.debug&#40;"entering 'handleRequest' method..."&#41;;
        &#125;
        return new ModelAndView&#40;"simpleReport","model", getModel&#40;&#41;&#41;;
    &#125;
&#125;

app-servlet.xml:

    <bean id="simpleReportController" class="org.appfuse.webapp.action.SimpleReportController" autowire="byName"/>
    <!-- Put controller mappings here -->

    <bean id="urlMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
        <property name="mappings">
            <props>
                <prop key="/popuplist/pesquisaItem.html">pesquisaItemController</prop>
                <prop key="/editVendaItem.html">vendaItemFormController</prop>
                   ...
                <prop key="/simpleReport.html">simpleReportController</prop>
                <!-- Add additional URL mappings here -->
            </props>
        </property>
    </bean>
     ...
    <!-- View Resolver for JSPs -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="requestContextAttribute"><value>rc</value></property>
        <property name="viewClass"><value>org.springframework.web.servlet.view.JstlView</value></property>
        <property name="prefix"><value>/WEB-INF/pages/</value></property>
        <property name="suffix"><value>.jsp</value></property>
    </bean> 
    <!-- JasperReports View Resolver for jasper'S -->
    <bean id="jasperReportsViewResolver" class="org.springframework.web.servlet.view.ResourceBundleViewResolver">
        <property name="basename">
            <value>views</value>
        </property>
    </bean>

After that I compiled and deployed the app. But when I go to the url http://localhost:8080/estoque/simpleReport.html I get this execption:

java.lang.IllegalArgumentException: No report data supplied in model {model={dataSource=net.sf.jasperreports.engine.data.JRBeanCollectionDataSource@103368e, ReportTitle=Dear Lord!}}
	at org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView.getReportData(AbstractJasperReportsView.java:195)
	at org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView.renderMergedOutputModel(AbstractJasperReportsView.java:163)
	at org.springframework.web.servlet.view.AbstractView.render(AbstractView.java:242)
	at org.springframework.web.servlet.DispatcherServlet.render(DispatcherServlet.java:784)

Any idea that caused this?

Thanks and Sore again!

Gilberto

[apuarimus]

Well, I figured out how to configure the view before I found the info bundled in the spring release, but still having issues. It does not appear that the reportDataKey I am setting is actually used to look up the datasource property in the model. I have set:
viewReport.class=org.springframework.web.servlet.v iew.jasperreports.JasperReportsPdfView
viewReport.url=/WEB-INF/reports/bookreport.jrxml
viewReport.reportDataKey=reportData

and in my controller I have:

model = new HashMap();
model.put("reportData", booklist);

'booklist' is an instance of a JRDataSource and model is returned. Does anyone have an example that also shows how they wire up everything in their spring-servlet.xml? Quite probably I am doing something wrong, but with no working examples to compare to...

When I try to access my servlet, I get:

java.lang.IllegalArgumentException: Value [null] cannot be converted to a JRDataSource
org.springframework.ui.jasperreports.JasperReports Utils.convertReportData(JasperReportsUtils.java:70 )
org.springframework.web.servlet.view.jasperreports .AbstractJasperReportsView.convertReportData(Abstr actJasperReportsView.java:213)
org.springframework.web.servlet.view.jasperreports .AbstractJasperReportsView.getReportData(AbstractJ asperReportsView.java:186)
org.springframework.web.servlet.view.jasperreports .AbstractJasperReportsView.renderMergedOutputModel (AbstractJasperReportsView.java:163)
org.springframework.web.servlet.view.AbstractView. render(AbstractView.java:247)
org.springframework.web.servlet.DispatcherServlet. render(DispatcherServlet.java:784)
org.springframework.web.servlet.DispatcherServlet. doService(DispatcherServlet.java:621)
org.springframework.web.servlet.FrameworkServlet.s erviceWrapper(FrameworkServlet.java:368)
org.springframework.web.servlet.FrameworkServlet.d oGet(FrameworkServlet.java:319)
javax.servlet.http.HttpServlet.service(HttpServlet .java:689)
javax.servlet.http.HttpServlet.service(HttpServlet .java:802)

[apuarimus]

Here are all the pieces that should get someone started. I have not yet figured out how to set parameters for the report yet.

BookController, which does all the work:

import org.springframework.web.servlet.mvc.Controller;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;

public class BookController implements Controller {
    private BookList bookList = new BookList();

    public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response)
        throws Exception
    {
        System.out.println("handle request");
        return new ModelAndView("viewList", "reportData", getModel());
    }

    public BookList getModel() {
        HashMap m = new HashMap();
        m.put("NAME", "Lord of the Rings: Fellowship of the Ring");
        m.put("BOOK_ID", new Integer(1));
        bookList.add(m);

        m = new HashMap();
        m.put("NAME", "Lord of the Rings: The Two Towers");
        m.put("BOOK_ID", new Integer(2));
        bookList.add(m);

        m = new HashMap();
        m.put("NAME", "Lord of the Rings: Return of the King");
        m.put("BOOK_ID", new Integer(3));
        bookList.add(m);

        return bookList;
    }

    public void setBookList(BookList b) {
        System.out.println("setBookList()");
        this.bookList = b;
    }

    public BookList getBookList() {
        System.out.println("getBookList()");
        return bookList;
    }
}

BookList model object:

import java.util.*;
import net.sf.jasperreports.engine.JRRewindableDataSource;
import net.sf.jasperreports.engine.JRField;
import net.sf.jasperreports.engine.JRException;

public class BookList implements JRRewindableDataSource {
    ArrayList books = new ArrayList();
    int pos = -1;

    public BookList() {
        System.out.println("book data source instantiated");
    }

    public void add(Map m) {
        books.add(m);
    }

    public void moveFirst() throws JRException {
        System.out.println("rewind");
        pos = 0;
    }

    public Object getFieldValue(JRField field) throws JRException {
        System.out.println("requesting field '"+field.getName()+"'");
        return ((Map)books.get(pos)).get(field.getName());
    }

    public boolean next() {
        System.out.println("next");
        if &#40;pos+1 < books.size&#40;&#41;&#41; &#123;
            pos++;
            System.out.println&#40;"next&#58; returning true"&#41;;
            return true;
        &#125;
        System.out.println&#40;"next&#58; returning false"&#41;;
        return false;
    &#125;
&#125;

The spring-servlet.xml:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http&#58;//www.springframework.org/dtd/spring-beans.dtd">

<!--
  - Application context definition for "springapp" DispatcherServlet.
  -->

<beans>
    <bean id="viewList" class="com.logicalapps.appscreate.BookController">
        <property name="bookList">
            <ref bean="bookBean"/>
        </property>
    </bean>

    <bean id="bookBean" class="com.logicalapps.appscreate.BookList"/>

    <bean id="handlerMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
        <property name="mappings">
            <props>
                <prop key="*.do">viewList</prop>
            </props>
        </property>
    </bean>

    <!-- The ResourceBundleViewResolver&#58; -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.ResourceBundleViewResolver">
        <property name="basename"><value>views</value></property>
    </bean>
</beans>

The views.properties:

viewList.class=org.springframework.web.servlet.view.jasperreports.JasperReportsPdfView
viewList.url=/WEB-INF/reports/bookreport.jrxml
viewList.reportDataKey=reportData

I am sure that there may be another way to do this and perhaps more elegant (I would love to see an example). Maybe those Spring Framework masters out there can help...I myself am a Spring Framework beginner (< few weeks =P). Anyone know how to pass parameters to the jasper report? Perhaps by adding some more wire-up and a couple lines of code...just not sure how. Either way, this doesn't appear to be working exactly how the documentation describes.

[shoosh]

Passing Parameters to Jasper : Anything that you put in your Model will be interpreted in Jasper as a parameter (note that any parameters you wish to access must also be delcared in your report file).

For example, if in your controller you put :

Model model = new Hashmap();
model.put("pageTitle", new String("Sample Report"));
model.put("pageAttributes", getPageAttributes()); // getPageAttributes returns some class com.xxx.MyPageAttributes

in your report, you have then to declare the parameters :
<parameter name="pageTitle" isForPrompting="false" class="java.lang.String"/>
<parameter name="pageAttributes" isForPrompting="false" class="com.xxx.MyPageAttributes"/>

then access them like any other parameters :
$P{pageTitle}

$P{pageAttributes}.getPriority() // or any other MyPage attributes method


Setting the jasper datasource : The datasource is used to populate the rows of the report. For example if you're displaying a list of products, the datasource is this list of products.

In your controller :

model = new HashMap();
model.put("reportData", productList); // productList must be of type Collection, array or JRDataSource or JRBeanCollectionDataSource and cannot be null - i think it also doesn't work if it's empty

Say productList is an array of Product beans. Product has properties "code" and "description".

In your report, you declare these properties as fields :

<field name="code" class="java.lang.Integer"/>
<field name="description" class="java.lang.String"/>

then you can access them as you would other fields :
$F{code}
$F{description}


I have it all working fine - the Spring classes work exactly as described.

[apuarimus]

I think it is great that you have everything working, but could you provide information that would help me convert my example above?

I am aware of what JasperReports needs to populate the report

I am also aware that any key/value in the model *should* be used as parameters as the documentation as clearly states:

Report parameters are simple name/value pairs and can be added be to the Map for your model as you would add any name/value pair.

However, if I do as you suggest and return a model which is an instance of a HashMap that contains the parameters and of course the datasource key mapped to datasource which is an instance of "JRDataSource or Collection" (as the reference documentation describes), I get an error:

java.lang.IllegalArgumentException: No report data supplied in model {reportData={reportData=com.logicalapps.appscreate .BookList@1603522, param1=value1}}

Note that this is what I originally tried, since the documentation states this is the way to do it. I have been unable to make this work though. Maybe you can shed some light on the specific adjustments I can make to the above example to get me where I need to be?

Your example restates what the documentation has stated, but doesn't get me any closer to determining why I can't successfully use a Map as the model for the JasperReportsPdfView. Something in the context of my example would be helpful, or perhaps a new example altogether with all the relevant pieces...

Cheers

[gilbertoca]

I agree with apuarimus!

Your example restates what the documentation has stated, but doesn't get me any closer to determining why I can't successfully use a Map as the model for the JasperReportsPdfView. Something in the context of my example would be helpful, or perhaps a new example altogether with all the relevant pieces...

Please, can someone help us with this problem?

Thanks, Gilberto

[robh]

All,

Sorry for the late reply - been away on holiday. I just got back but I promise I will post a solution to this tomorrow

Rob