001    //$ Header: Exp $
002    /*---------------- FILE HEADER ------------------------------------------
003     This file is part of deegree.
004     Copyright (C) 2001-2004 by:
005     EXSE, Department of Geography, University of Bonn
006     http://www.giub.uni-bonn.de/exse/
007     lat/lon GmbH
008     http://www.lat-lon.de
009     This library is free software; you can redistribute it and/or
010     modify it under the terms of the GNU Lesser General Public
011     License as published by the Free Software Foundation; either
012     version 2.1 of the License, or (at your option) any later version.
013     This library is distributed in the hope that it will be useful,
014     but WITHOUT ANY WARRANTY; without even the implied warranty of
015     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
016     Lesser General Public License for more details.
017     You should have received a copy of the GNU Lesser General Public
018     License along with this library; if not, write to the Free Software
019     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020     Contact:
021     Dr. Andreas Poth
022     lat/lon GmbH
023     Aennchenstr. 19
024     53177 Bonn
025     Germany
026     E-Mail: poth@lat-lon.de
027     Prof. Dr. Klaus Greve
028     Department of Geography
029     University of Bonn
030     Meckenheimer Allee 166
031     53115 Bonn
032     Germany
033     E-Mail: greve@giub.uni-bonn.de
034     ---------------------------------------------------------------------------*/
035    
036    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/ogcwebservices/wmps/configuration/PrintMapParam.java $
037    /*----------------    FILE HEADER  ------------------------------------------
038    
039     This file is part of deegree.
040     Copyright (C) 2001-2005 by:
041     EXSE, Department of Geography, University of Bonn
042     http://www.giub.uni-bonn.de/exse/
043     lat/lon GmbH
044     http://www.lat-lon.de
045    
046     This library is free software; you can redistribute it and/or
047     modify it under the terms of the GNU Lesser General Public
048     License as published by the Free Software Foundation; either
049     version 2.1 of the License, or (at your option) any later version.
050    
051     This library is distributed in the hope that it will be useful,
052     but WITHOUT ANY WARRANTY; without even the implied warranty of
053     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
054     Lesser General Public License for more details.
055    
056     You should have received a copy of the GNU Lesser General Public
057     License along with this library; if not, write to the Free Software
058     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
059    
060     Contact:
061    
062     Andreas Poth
063     lat/lon GmbH
064     Aennchenstraße 19
065     53177 Bonn
066     Germany
067     E-Mail: poth@lat-lon.de
068    
069     Jens Fitzke
070     lat/lon GmbH
071     Aennchenstraße 19
072     53177 Bonn
073     Germany
074     Germany
075     E-Mail: fitzke@lat-lon.de
076     
077     ---------------------------------------------------------------------------*/
078    
079    package org.deegree.ogcwebservices.wmps.configuration;
080    
081    /**
082     * This class is a container to store the print map parameters used to access the (jasper reports)
083     * template and output directory parameters.
084     * 
085     * @author <a href="mailto:deshmukh@lat-lon.de">Anup Deshmukh</a>
086     * 
087     * @author last edited by: $Author: bezema $
088     * 
089     * @version $Revision: 6259 $, $Date: 2007-03-20 10:15:15 +0100 (Di, 20 Mär 2007) $
090     */
091    
092    public class PrintMapParam {
093    
094        private String format;
095    
096        private String templateDirectory;
097    
098        private String onlineResource;
099    
100        private String plotDirectory;
101    
102        private String plotImageDir;
103    
104        private String adminMailAddress;
105    
106        private String mailHost;
107    
108        private String mailTextTemplate;
109    
110        private int targetResolution = 300;
111    
112        /**
113         * Create a new PrintMapParam instance.
114         * 
115         * @param format
116         * @param templateDirectory
117         * @param onlineResource
118         * @param plotDirectory
119         * @param plotImageDir
120         * @param adminMailAddress
121         * @param mailHost
122         */
123        public PrintMapParam( String format, String templateDirectory, String onlineResource,
124                              String plotDirectory, String plotImageDir, String adminMailAddress,
125                              String mailHost, String mailTextTemplate, int targetResolution ) {
126            this.format = format;
127            this.templateDirectory = templateDirectory;
128            this.onlineResource = onlineResource;
129            this.plotDirectory = plotDirectory;
130            this.plotImageDir = plotImageDir;
131            this.adminMailAddress = adminMailAddress;
132            this.mailHost = mailHost;
133            this.mailTextTemplate = mailTextTemplate;
134            this.targetResolution = targetResolution;
135        }
136    
137        /**
138         * @return Returns the format. default: pdf
139         */
140        public String getFormat() {
141            return this.format;
142        }
143    
144        /**
145         * @return Returns the plotDirectory.
146         */
147        public String getPlotDirectory() {
148            return this.plotDirectory;
149        }
150    
151        /**
152         * @return Returns the adminMailAddress.
153         */
154        public String getAdminMailAddress() {
155            return this.adminMailAddress;
156        }
157    
158        /**
159         * @return Returns the mailHost.
160         */
161        public String getMailHost() {
162            return this.mailHost;
163        }
164    
165        /**
166         * @return Returns the plotImgDir.
167         */
168        public String getPlotImageDir() {
169            return this.plotImageDir;
170        }
171    
172        /**
173         * @return Returns the templateDirectory.
174         */
175        public String getTemplateDirectory() {
176            return this.templateDirectory;
177        }
178    
179        /**
180         * @return Returns the onlineResource.
181         */
182        public String getOnlineResource() {
183            return this.onlineResource;
184        }
185    
186        /**
187         * returns the template (text) for creating a mail to inform a user where to access the result
188         * of a PrintMap request
189         * 
190         * @return the template (text) for creating a mail to inform a user where to access the result
191         *         of a PrintMap request
192         */
193        public String getMailTextTemplate() {
194            return mailTextTemplate;
195        }
196    
197        /**
198         * returns the resolution of the print target in DPI
199         * 
200         * @return the resolution of the print target in DPI
201         */
202        public int getTargetResolution() {
203            return targetResolution;
204        }
205    
206    }
207    
208    /***************************************************************************************************
209     * <code>
210     Changes to this class. What the people have been up to: 
211     
212     $Log$
213     Revision 1.8  2007/02/27 13:02:11  wanhoff
214     fixed Javadoc @return tags and footer
215    
216     Revision 1.7  2006/11/02 21:06:03  poth
217     bug fix - scale calculation
218     
219     Revision 1.6  2006/10/02 06:30:36  poth
220     bug fixes
221     
222     Revision 1.5  2006/08/31 10:29:37  deshmukh
223     renamed variable
224     
225     Revision 1.4 2006/08/24 06:42:17 poth
226     File header corrected 
227     
228     Revision 1.3 2006/08/10 07:11:35 deshmukh 
229     WMPS has been modified to support the new configuration changes and the excess code not needed has been replaced.
230     
231     Revision 1.2 2006/08/01 14:20:10 deshmukh 
232     The wmps configuration has been modified and extended. Also fixed the javadoc. 
233     
234     Revision 1.1 2006/07/31 11:21:07 deshmukh 
235     wmps implemention...
236     
237     </code>
238     **************************************************************************************************/