[Treebase-guts] SF.net SVN: treebase:[81] trunk/treebase-web/src/main/java/org/cipres/ treebase/web/controllers/AbstractDownloadController.java

[<rv...@us...>]

Revision: 81
          http://treebase.svn.sourceforge.net/treebase/?rev=81&view=rev
Author:   rvos
Date:     2009-06-23 11:08:34 +0000 (Tue, 23 Jun 2009)

Log Message:
-----------
Adding AbstractDownloadController, a superclass for MVC controllers that generate downloadable files (nexus,nexml)

Added Paths:
-----------
    trunk/treebase-web/src/main/java/org/cipres/treebase/web/controllers/AbstractDownloadController.java

Added: trunk/treebase-web/src/main/java/org/cipres/treebase/web/controllers/AbstractDownloadController.java
===================================================================
--- trunk/treebase-web/src/main/java/org/cipres/treebase/web/controllers/AbstractDownloadController.java	                        (rev 0)
+++ trunk/treebase-web/src/main/java/org/cipres/treebase/web/controllers/AbstractDownloadController.java	2009-06-23 11:08:34 UTC (rev 81)
@@ -0,0 +1,119 @@
+package org.cipres.treebase.web.controllers;
+
+import java.io.File;
+import java.io.FileWriter;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.cipres.treebase.TreebaseUtil;
+import org.cipres.treebase.domain.nexus.NexusService;
+import org.cipres.treebase.web.util.WebUtil;
+import org.springframework.web.servlet.mvc.Controller;
+
+public abstract class AbstractDownloadController implements Controller {
+	protected String mFormatParameter = "format";
+	protected static final int FORMAT_NEXUS = 1;
+	protected static final int FORMAT_NEXML = 2;
+	private NexusService mNexmlService;	
+	private static String mNexmlContentType = "application/xml";
+	
+	/**
+	 * 
+	 * @param request
+	 * @return
+	 */
+	protected int getFormat (HttpServletRequest request) {
+		String requestedFormat = request.getParameter(mFormatParameter);
+		if ( null != requestedFormat ) {
+			if ( requestedFormat.equalsIgnoreCase("nexml") ) {
+				return FORMAT_NEXML;
+			}
+			else {
+				return FORMAT_NEXUS; // default
+			}
+		}
+		else {
+			return FORMAT_NEXUS; // default
+		}
+	}
+	
+	/**
+	 * 
+	 * @param objectId
+	 * @param request
+	 * @return
+	 */
+	protected String getFileName(long id,HttpServletRequest request) {
+		if ( getFormat(request) == FORMAT_NEXML ) {
+			return getFileNamePrefix() + id + ".xml";
+		}
+		return getFileNamePrefix() + id + ".nex";
+	}	
+	
+	/**
+	 * 
+	 * @return a context-dependent prefix (e.g. "M" for a matrix)
+	 */
+	protected abstract String getFileNamePrefix();
+	
+	/**
+	 * 
+	 * @return a context-dependent serialization (e.g. a nexus string)
+	 */
+	protected abstract String getFileContent(long objectId,HttpServletRequest request);
+	
+	protected String getDownloadDir (HttpServletRequest request) {
+		String downloadDir = request.getSession().getServletContext().getRealPath(
+				TreebaseUtil.FILESEP + "NexusFileDownload")
+				+ TreebaseUtil.FILESEP + request.getRemoteUser();
+		return downloadDir;
+	}
+
+	/**
+	 * 
+	 * @param request
+	 * @param pFileContent
+	 * @param objectId
+	 * @param downloadDirName
+	 */
+	protected void generateAFileDynamically(HttpServletRequest request, HttpServletResponse response, long objectId) {
+		String downloadDirName = getDownloadDir(request);
+		File dirPath = new File(downloadDirName);
+		if (!dirPath.exists()) {
+			dirPath.mkdirs();
+		}
+		String fileName = getFileName(objectId,request);
+		try {
+			File file = new File(downloadDirName + TreebaseUtil.FILESEP + fileName);
+			FileWriter out = new FileWriter(file);
+			out.write(getFileContent(objectId,request));
+			out.close();
+			if ( getFormat(request) == FORMAT_NEXML ) {
+				WebUtil.downloadFile(response, downloadDirName, fileName, mNexmlContentType);
+			}
+			else {
+				WebUtil.downloadFile(response, downloadDirName, fileName);
+			}
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+	}
+
+	/**
+	 * 
+	 * @return
+	 */
+	public NexusService getNexmlService() {
+		return mNexmlService;
+	}
+
+	/**
+	 * 
+	 * @param nexmlService
+	 */
+	public void setNexmlService(NexusService nexmlService) {
+		mNexmlService = nexmlService;
+	}
+
+}


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.