View Javadoc
1   /*******************************************************************************
2    *   Gisgraphy Project 
3    * 
4    *   This library is free software; you can redistribute it and/or
5    *   modify it under the terms of the GNU Lesser General Public
6    *   License as published by the Free Software Foundation; either
7    *   version 2.1 of the License, or (at your option) any later version.
8    * 
9    *   This library is distributed in the hope that it will be useful,
10   *   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12   *   Lesser General Public License for more details.
13   * 
14   *   You should have received a copy of the GNU Lesser General Public
15   *   License along with this library; if not, write to the Free Software
16   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
17   * 
18   *  Copyright 2008  Gisgraphy project 
19   *  David Masclet <davidmasclet@gisgraphy.com>
20   *  
21   *  
22   *******************************************************************************/
23  package com.gisgraphy.geoloc;
24  
25  import java.io.OutputStream;
26  import java.util.Map;
27  
28  import com.gisgraphy.serializer.common.OutputFormat;
29  
30  public interface IGeolocResultsDtoSerializer {
31  
32  
33      /**
34       * @param outputStream the {@link OutputStream} to serialize in
35       * @param outputFormat the outputFormat we'd like to serialize the geolocResultsDto
36       * @param geolocResultsDto the geolocResultsDto to serialize
37       * @param indent whether the stream should be indented (if the format support indentation)
38       * @param extraParameters a map that contains named parameters (callback method, startpaginationindex, needed for RSS and ATOM)
39       * the parameters can be use for a certain format but not for all)
40       */
41      public abstract void serialize(OutputStream outputStream,OutputFormat outputFormat,
42  	    GeolocResultsDto geolocResultsDto,boolean indent,Map<String,Object> extraParameters);
43  
44  }