Raible's Wiki: AppFuseJasperReports




public class UserReportController extends MultiActionController {

    private transient final Log log = LogFactory.getLog(UserReportController.class);

    private UserManager userManager = null;



    public UserManager getUserManager() {

        return userManager;

    }



    public void setUserManager(UserManager mgr) {

        this.userManager = mgr;

    }



    public ModelAndView userReport(HttpServletRequest request, HttpServletResponse response)throws Exception {

      if (log.isDebugEnabled()) {

        log.debug("entering 'userReport' method...");

      }

      Map model = new HashMap();

      //It is the path of our webapp - is there a better way to do this?

      String reportResourcePath =  getServletContext().getRealPath("/");



      String format = request.getParameter("format");

      //Default format to pdf

      if (StringUtils.hasText(format)){

        if (!(format.equalsIgnoreCase("pdf") || format.equalsIgnoreCase("html")

            || format.equalsIgnoreCase("csv") || format.equalsIgnoreCase("xls"))){

            format = "pdf";

        }

      }else{

        format = "pdf";

      }



        model.put("format", format);

        model.put("WEBDIR", reportResourcePath);

        model.put("dataSource", getUserManager().getUsers(new User()));

        return new ModelAndView("userMultiFormatReport", model);

    }

}

MultiActionController resolves method names based on a method name resolver. The default method name resolver is InternalPathMethodNameResolver, which resolves method names based on URL patterns. But Spring comes with two other method name resolvers:

Regardless of which method name resolver you choose, you’ll need to wire it into the methodNameResolver property of the MultiActionController to override the default. In the configuration file action-servlet.xml, makes the following modifications - we will use the first method to decide names:




‹bean id="methodNameResolver" class="org.springframework.web.servlet.mvc.multiaction.ParameterMethodNameResolver"›

    ‹property name="paramName"›

       ‹value›action‹/value›

    ‹/property›

‹/bean›



‹bean id="userReportController" class="org.appfuse.webapp.action.UserReportController"›

     ‹property name="methodNameResolver" ref="methodNameResolver"/›

     ‹property name="userManager" ref="userManager"/›

‹/bean›

The requests would be of the following form: /appfuse/userReport.html?action=userReport and thus for ahead, for each method that you add in the class userReportController. Another thing that we do not have to forget is to establish which URL will use to call this controller. As this URL is one of the administrative tasks, we will go to place this mapping in the Bean adminUrlMapping:




        ‹property name="mappings"›

            ‹props›

                ‹prop key="/activeUsers.html"›filenameController‹/prop›

                ‹prop key="/users.html"›userController‹/prop›

                ‹prop key="/userReport.html"›userReportController‹/prop›

                ‹prop key="/flushCache.html"›filenameController‹/prop›

                ‹prop key="/reload.html"›reloadController‹/prop›

            ‹/props›

        ‹/property›

Now the most important, let's verify if everything is correct through the execution of the test of unit for this class. We already know that the current test will fail! This because we do not create our report and therefore we do not define who will resolve the name of the JasperReports's report file, userList.jrxml. Then, in our test class UserReportControllerTest, we have to test the existence of view userReport with format pdf:




public class UserReportControllerTest extends BaseControllerTestCase {

    private UserReportController c;

    private MockHttpServletRequest request;

    private ModelAndView mav;



    protected void setUp() throws Exception {

        // needed to initialize a user

        super.setUp();

        c = (UserReportController) ctx.getBean("userReportController");

    }



    protected void tearDown() {

        c = null;

    }



    public void testUserReportDefalutPdf() throws Exception {

        mav = c.userReport(new MockHttpServletRequest(),

                (HttpServletResponse) null);

        Map m = mav.getModel();

        assertEquals("Default format is pdf",m.get("format").toString(),"pdf");

        assertEquals(mav.getViewName(), "userMultiFormatReport");

    }

}

Configuring JasperReports on AppFuse [#2]

Now the necessary steps to (AppFuseAddLibrary) set up JasperReports on AppFuse. For that, we will include the lastest release version of JasperReports, which in the hour of this writing was 1.2.0. JasperReports itself depends on the following projects:

1. Create a new folder for your library in /lib using the pattern libname-version (e.g. /lib/iText-1.1).

2. Add all required .jar's into the folder you created. (e.g. /lib/iText-1.1/iText.jar)

/lib/jasper-reports-1.2.0/jasperreports-1.2.0.jar /lib/jasper-reports-1.2.0/jr-bsh-compiler.jar /lib/itext-1.1.4/itext-1.1.4.jar /lib/poi-2.5.1/poi-2.5.1.jar /lib/bsh-2.0b2/bsh-2.0b2.jar

3. Edit /lib/lib.properties to include a section like the following for your library.

5. The last step is making sure the library gets added to your deployed webapp. In the package-web target of /build.xml look for the element and add another element.

Designing Reports [#3]

The amused part arrived! With the aid of the designing tool iReports, we will construct a report based on the list of users of the AppFuse. We will use the lastest release of iReports, which in the hour of this writing was 1.2.0. It will not be a complex report, only a list of accounts of users with the following columns:

Putting all together [#4]

Finally we will configure the jrxml file and the resolver for pdf, xsl, csv and HTML formats.

1. Create a new folder for your reports in /web/WEB-INF with the name reports.

3. Edit /WEB-INF/action-servlet.xml file to include the following section for the resolver and view, that we will use. You should have noted that in the UserReportController' method, we're using one parameter to define the format of the report's result at runtime. That is, we will use JasperReportsMultiFormatView view. First the resolver:

Raible's Wiki

AppFuse

Other Applications

AppFuseJasperReports

JasperReport on AppFuse - Putting JasperReports to work on AppFuse.

About this Tutorial

Table of Contents

Create the UserReportController Controller [#1]

Configuring JasperReports on AppFuse [#2]

Designing Reports [#3]

Putting all together [#4]