1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/java/cewolf-1.0/src/main/java/de/laures/cewolf/Storage.java	Sat Feb 28 21:31:02 2009 +0100
     1.3 @@ -0,0 +1,87 @@
     1.4 +/* ================================================================
     1.5 + * Cewolf : Chart enabling Web Objects Framework
     1.6 + * ================================================================
     1.7 + *
     1.8 + * Project Info:  http://cewolf.sourceforge.net
     1.9 + * Project Lead:  Guido Laures (guido@laures.de);
    1.10 + *
    1.11 + * (C) Copyright 2002, by Guido Laures
    1.12 + *
    1.13 + * This library is free software; you can redistribute it and/or modify it under the terms
    1.14 + * of the GNU Lesser General Public License as published by the Free Software Foundation;
    1.15 + * either version 2.1 of the License, or (at your option) any later version.
    1.16 + *
    1.17 + * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
    1.18 + * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    1.19 + * See the GNU Lesser General Public License for more details.
    1.20 + *
    1.21 + * You should have received a copy of the GNU Lesser General Public License along with this
    1.22 + * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
    1.23 + * Boston, MA 02111-1307, USA.
    1.24 + */
    1.25 +
    1.26 +package de.laures.cewolf;
    1.27 +
    1.28 +import javax.servlet.ServletContext;
    1.29 +import javax.servlet.http.HttpServletRequest;
    1.30 +import javax.servlet.http.HttpSession;
    1.31 +import javax.servlet.jsp.PageContext;
    1.32 +
    1.33 +/**
    1.34 + * Pluggable storage. Implement this class to change the
    1.35 + * storage concept which Cewolf uses to store chart imanges and
    1.36 + * provide the implementation class name as init paramter <em>storage</em>
    1.37 + * for Cewolf servlet.
    1.38 + * @author glaures
    1.39 + */
    1.40 +public interface Storage{
    1.41 +	
    1.42 +	/**
    1.43 +	 * Stores a chart image.
    1.44 +	 * @param cid the image to be stored
    1.45 +	 * @param servletContext servletContext which might be needed
    1.46 +	 * @return String the storage id which is used to find the image in storage
    1.47 +	 */
    1.48 +	public String storeChartImage(ChartImage chartImage, PageContext pageContext) throws CewolfException;
    1.49 +  
    1.50 +	/**
    1.51 +	 * Retrieves a chart image.
    1.52 +	 * @param id the id of the image
    1.53 +	 * @param request the request
    1.54 +	 * @return ChartImage the stored image instance
    1.55 +	 */
    1.56 +	public ChartImage getChartImage(String id, HttpServletRequest request);
    1.57 +    
    1.58 +	/**
    1.59 +	 * Tests if a chart image is already available in thsi store..
    1.60 +	 * @param chartImage the image to test
    1.61 +	 * @param pageContext the pageContext
    1.62 +	 * @return <code>true</code> if a stored instance of this image is availbale
    1.63 +	 */
    1.64 +	// public boolean contains(ChartImage chartImage, PageContext pageContext);
    1.65 +	
    1.66 +	/**
    1.67 +	 * Returns the key for this 
    1.68 +	 * @param chartImage
    1.69 +	 * @return String
    1.70 +	 */
    1.71 +	// public String getKey(ChartImage chartImage);
    1.72 +	
    1.73 +	/**
    1.74 +	 * Method init.
    1.75 +	 * @param servletContext
    1.76 +	 * @throws CewolfException
    1.77 +	 */
    1.78 +	public void init(ServletContext servletContext) throws CewolfException;
    1.79 +
    1.80 +
    1.81 +	/**
    1.82 +	 * Removes the image from the storage
    1.83 +	 * @param imgId Image id
    1.84 +	 * @param request Servlet request
    1.85 +	 * @return Image id
    1.86 +	 * @throws CewolfException
    1.87 +	 */
    1.88 +	public String removeChartImage(String imgId, HttpServletRequest request)
    1.89 +			throws CewolfException;
    1.90 +}