/*
    * Copyright (c) 2002-2014, Mairie de Paris
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    *
    *  1. Redistributions of source code must retain the above copyright notice
   *     and the following disclaimer.
   *
   *  2. Redistributions in binary form must reproduce the above copyright notice
   *     and the following disclaimer in the documentation and/or other materials
   *     provided with the distribution.
   *
   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
   *     contributors may be used to endorse or promote products derived from
   *     this software without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   *
   * License 1.0
   */
  package fr.paris.lutece.plugins.directory.modules.gismap.business.portlet;
  
  import java.util.List;
  
  import javax.servlet.http.HttpServletRequest;
  
  import org.apache.commons.lang.BooleanUtils;
  
  import fr.paris.lutece.plugins.directory.modules.gismap.business.DirectoryGismapSourceQuery;
  import fr.paris.lutece.plugins.directory.modules.gismap.service.GismapDirectoryService;
  import fr.paris.lutece.portal.business.portlet.Portlet;
  import fr.paris.lutece.portal.business.portlet.PortletHome;
  import fr.paris.lutece.portal.service.util.AppPropertiesService;
  import fr.paris.lutece.util.xml.XmlUtil;
  
  /**
   * This class represents business objects ArticlesList Portlet
   */
  public class GismapDirectoryPortlet extends Portlet
  {
      // ///////////////////////////////////////////////////////////////////////////////
      // Xml Tags
      private static final String TAG_GISMAP_PORTLET         = "gismap-portlet";
      private static final String TAG_GISMAP_PORTLET_CONTENT = "gismap-portlet-content";
  
      // ///////////////////////////////////////////////////////////////////////////////
      
  	public static final String   GISMAP_DEFAULT_VIEW_PROPERTIES = "gismap.mainmap.defaultview";
  	public static final String 	MAX_LAYER_GEOJSON_PROPERTY = "directory-gismap.portlet.maxLayerGeojson";
  
      // Constants
      private int                 _nPortletId;
      private int                 _nStatus;
      private	int					_nview;
  	private List<DirectoryGismapSourceQuery> _listMapSource;
  
      /**
       * Sets the identifier of the portlet type to the value specified in the
       * ArticlesListPortletHome class
       */
      public GismapDirectoryPortlet( )
      {
      }
  
      /**
       * Returns the Xml code of the form portlet without XML heading
       *
       * @param request The HTTP Servlet request
       * @return the Xml code of the form portlet content
       */
      @Override
      public String getXml( HttpServletRequest request )
      {
      	GismapDirectoryPortlet portlet = ( GismapDirectoryPortlet ) PortletHome.findByPrimaryKey( getId( ) );
      	List<DirectoryGismapSourceQuery> listGeojsonSources = portlet.getListMapSource( );
  
      	String viewId = String.valueOf( portlet.getView( ) );
  
      	StringBuffer strXml = new StringBuffer( );
      	XmlUtil.beginElement( strXml, TAG_GISMAP_PORTLET );
      	if ( !BooleanUtils.toBoolean( portlet.getDisplayPortletTitle( ) ) )
      	{
      		XmlUtil.addElementHtml( strXml, TAG_GISMAP_PORTLET_CONTENT, "<h3>" + portlet.getName( ) + "</h3>" );
      	}
      	XmlUtil.addElementHtml( strXml, TAG_GISMAP_PORTLET_CONTENT, GismapDirectoryService.getInstance( ).getMapTemplateWithDirectoryGismapSources(request, viewId, listGeojsonSources) );
  
     	XmlUtil.endElement( strXml, TAG_GISMAP_PORTLET );
 
     	return addPortletTags( strXml );
     }
 
     /**
      * Returns the Xml code of the form portlet with XML heading
      *
      * @param request The HTTP Servlet Request
      * @return the Xml code of the Articles List portlet
      */
     @Override
     public String getXmlDocument( HttpServletRequest request )
     {
         return XmlUtil.getXmlHeader( ) + getXml( request );
     }
 
     /**
      * Updates the current instance of the form portlet object
      */
     public void update( )
     {
         GismapDirectoryPortletHome.getInstance( ).update( this );
     }
 
     /**
      * Removes the current instance of the the form portlet object
      */
     @Override
     public void remove( )
     {
         GismapDirectoryPortletHome.getInstance( ).remove( this );
     }
 
     /**
      * Returns the nPortletId
      *
      * @return The nPortletId
      */
     public int getPortletId( )
     {
         return _nPortletId;
     }
 
     /**
      * Sets the IdPortlet
      *
      * @param nPortletId The nPortletId
      */
     public void setPortletId( int nPortletId )
     {
         _nPortletId = nPortletId;
     }
 
 
     /**
      * Returns the Status
      *
      * @return The Status
      */
     @Override
     public int getStatus( )
     {
         return _nStatus;
     }
 
     /**
      * Sets the Status
      *
      * @param nStatus The Status
      */
     @Override
     public void setStatus( int nStatus )
     {
         _nStatus = nStatus;
     }
 
     /**
      * Returns the map View
      * @param _nview 
      *
      * @return The View
      */
 	public int getView( )
 	{
 		// TODO Auto-generated method stub
 		return _nview;
 	}
 	
     /**
      * Sets the map View
      * @param _nview 
      *
      */
 	public void setView( int nView )
 	{
 		_nview = nView;
 	}
 
     /**
      * getter for the List of MapSource
      * @param listDirectoryGismapSource 
      *
      */
 	public List<DirectoryGismapSourceQuery> getListMapSource( )
 	{
 		return this._listMapSource;
 		
 	}
 	
     /**
      * Setter for the List of MapSource
      * @param listDirectoryGismapSource 
      *
      */
 	public void setListMapSource(List<DirectoryGismapSourceQuery> listDirectoryGismapSource)
 	{
 		this._listMapSource = listDirectoryGismapSource;		
 	}
 }