/*
    * 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.digglike.business;
  
  import fr.paris.lutece.plugins.digglike.utils.DiggUtils;
  import fr.paris.lutece.portal.service.resource.IExtendableResource;
  import fr.paris.lutece.util.date.DateUtil;
  import fr.paris.lutece.util.xml.XmlUtil;
  
  import java.sql.Timestamp;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Locale;
  
  import javax.servlet.http.HttpServletRequest;
  
  
  /**
   * 
   * class DiggSubmit
   * 
   */
  public class DiggSubmit implements IExtendableResource
  {
      public static final String RESOURCE_TYPE = "DIGGLIKE_DIGG_SUBMIT_TYPE";
      public static final int STATE_DISABLE = 1;
      public static final int STATE_WAITING_FOR_PUBLISH = 2;
      public static final int STATE_PUBLISH = 3;
      private static final String TAG_DIGG_SUBMIT = "digg-submit";
      private static final String TAG_DIGG_SUBMIT_TITLE = "digg-submit-title";
      private static final String TAG_DIGG_SUBMIT_CATEGORY = "digg-submit-category";
      private static final String TAG_DIGG_SUBMIT_TYPE = "digg-submit-type";
      private static final String TAG_DIGG_SUBMIT_DATE_RESPONSE = "digg-submit-date-response";
      private static final String TAG_DIGG_SUBMIT_NUMBER_VOTE = "digg-submit-number-vote";
      private static final String TAG_DIGG_SUBMIT_NUMBER_COMMENT = "digg-submit-number-comment";
      private static final String TAG_DIGG_SUBMIT_SCORE = "digg-submit-score";
      private static final String TAG_DIGGS_SUBMIT_COMMENTS = "digg-submit-comments";
      private static final String TAG_DIGGS_SUBMIT_RESPONSES = "digg-submit-responses";
      private int _nIdDiggSubmit;
      private Timestamp _tDateResponse;
      private Digg _digg;
      private DiggSubmitState _diggSubmitState;
      private List<Response> _listResponse;
      private Category _category;
      private int _nNumberVote;
      private int _nNumberScore;
      private int _nNumberEnableComment;
      private int _nNumberComment;
      private int _nNumberView;
      private String _strDiggSubmitValue;
      private String _strDiggSubmitTitle;
      private String _strDiggSubmitValueShowInTheList;
      private boolean _bReported;
      private String _strLuteceUserKey;
      private List<CommentSubmit> _listComments;
      private int _nDiggSubmitOrder;
      private DiggSubmitType _diggSubmitType;
      private boolean _bDisableVote;
      private boolean _bDisableComment;
      private boolean _bPinned;
      private List<ReportedMessage> _listReportedMessages;
      private Integer _nIdImageResource;
  
      /**
       * true if the digg submit have been reported by people
       * @return true if the digg submit have been reported by people
       */
      public boolean isReported( )
     {
         return _bReported;
     }
 
     /**
      * set true if the digg submit have been reported by people
      * @param reported true if the digg submit have been reported by people
      */
     public void setReported( boolean reported )
     {
         _bReported = reported;
     }
 
     /**
      * 
      * @return the title of the digg submit
      */
     public String getDiggSubmitTitle( )
     {
         return _strDiggSubmitTitle;
     }
 
     /**
      * set the title of the digg submit
      * @param diggSubmitTitle the title of the digg submit
      */
     public void setDiggSubmitTitle( String diggSubmitTitle )
     {
         _strDiggSubmitTitle = diggSubmitTitle;
     }
 
     /**
      * 
      * @return the digg associate to the submit
      */
     public Digg getDigg( )
     {
         return _digg;
     }
 
     /**
      * 
      * set the digg associate to the submit
      * @param digg the digg associate to the submit
      */
     public void setDigg( Digg digg )
     {
         this._digg = digg;
     }
 
     /**
      * return the id of the digg submit
      * @return the id of the digg submit
      */
     public int getIdDiggSubmit( )
     {
         return _nIdDiggSubmit;
     }
 
     /**
      * set the id of the digg submit
      * @param idDiggSubmit the id of the digg submit
      */
     public void setIdDiggSubmit( int idDiggSubmit )
     {
         _nIdDiggSubmit = idDiggSubmit;
     }
 
     /**
      * return the digg submit date
      * @return the digg submit date
      */
     public Timestamp getDateResponse( )
     {
         return _tDateResponse;
     }
 
     /**
      * set the digg submit date
      * @param dateResponse digg submit date
      */
     public void setDateResponse( Timestamp dateResponse )
     {
         _tDateResponse = dateResponse;
     }
 
     /**
      * 
      * @return the list of response associate to the digg submit
      */
     public List<Response> getResponses( )
     {
         return _listResponse;
     }
 
     /**
      * set the list of response associate to the digg submit
      * @param listResponse the list of response associate to the digg submit
      */
     public void setResponses( List<Response> listResponse )
     {
         _listResponse = listResponse;
     }
 
     /**
      * 
      * @return the digg submit state (published,enabled,disabled)
      */
     public DiggSubmitState getDiggSubmitState( )
     {
         return _diggSubmitState;
     }
 
     /**
      * set the digg submit state (published,enabled,disabled)
      * @param submitState the digg submit state (published,enabled,disabled)
      */
     public void setDiggSubmitState( DiggSubmitState submitState )
     {
         _diggSubmitState = submitState;
     }
 
     /**
      * 
      * @return the category associated to the digg submit
      */
     public Category getCategory( )
     {
         return _category;
     }
 
     /**
      * set the category associated to the digg submit
      * @param category the category associated to the digg submit
      */
     public void setCategory( Category category )
     {
         _category = category;
     }
 
     /**
      * 
      * @return the number of vote
      */
     public int getNumberVote( )
     {
         return _nNumberVote;
     }
 
     /**
      * set the number of vote
      * @param numberVote the number of vote
      */
     public void setNumberVote( int numberVote )
     {
         _nNumberVote = numberVote;
     }
 
     /**
      * return the score of the digg submit
      * @return the score of the digg submit
      */
     public int getNumberScore( )
     {
         return _nNumberScore;
     }
 
     /**
      * set the score of the digg submit
      * @param numberScore the score of the digg submit
      */
     public void setNumberScore( int numberScore )
     {
         _nNumberScore = numberScore;
     }
 
     /**
      * 
      * @return the digg submit value
      */
     public String getDiggSubmitValue( )
     {
         return _strDiggSubmitValue;
     }
 
     /**
      * set the digg submit value
      * @param diggSubmitValue the digg submit value
      */
     public void setDiggSubmitValue( String diggSubmitValue )
     {
         _strDiggSubmitValue = diggSubmitValue;
     }
 
     /**
      * 
      * @return the digg submit value show in the list of digg submit
      */
     public String getDiggSubmitValueShowInTheList( )
     {
         return _strDiggSubmitValueShowInTheList;
     }
 
     /**
      * set the digg submit value show in the list of digg submit
      * @param diggSubmitValue the digg submit value show in the list of digg
      *            submit
      */
     public void setDiggSubmitValueShowInTheList( String diggSubmitValue )
     {
         _strDiggSubmitValueShowInTheList = diggSubmitValue;
     }
 
     /**
      * 
      * @return the number of enable comment associated to the digg submit
      */
     public int getNumberCommentEnable( )
     {
         return _nNumberEnableComment;
     }
 
     /**
      * set the number of enable comment associated to the digg submit
      * @param numberComment the number of enable comment associated to the digg
      *            submit
      */
     public void setNumberCommentEnable( int numberComment )
     {
         _nNumberEnableComment = numberComment;
     }
 
     /**
      * 
      * @return the number of comment associated to the digg submit
      */
     public int getNumberComment( )
     {
         return _nNumberComment;
     }
 
     /**
      * set the number of comment associated to the digg submit
      * @param numberComment the number of comment associated to the digg submit
      */
     public void setNumberComment( int numberComment )
     {
         _nNumberComment = numberComment;
     }
 
     /**
      * 
      * @return the number of view associated to the digg submit
      */
     public int getNumberView( )
     {
         return _nNumberView;
     }
 
     /**
      * set the number of view associated to the digg submit
      * @param nNumberView the number of view associated to the digg submit
      */
     public void setNumberView( int nNumberView )
     {
         _nNumberView = nNumberView;
     }
 
     /**
      * 
      * @return the lutece user key associate to the digg submit
      */
     public String getLuteceUserKey( )
     {
         return _strLuteceUserKey;
     }
 
     /**
      * 
      * set the lutece user key associate to the digg submit
      * @param strLuteceUserKey the lutece user key associate to the digg submit
      */
     public void setLuteceUserKey( String strLuteceUserKey )
     {
         _strLuteceUserKey = strLuteceUserKey;
     }
 
     /**
      * Returns the xml of this digg submit
      * 
      * @param request The HTTP Servlet request
      * @param locale the Locale
      * @return the xml of this digg submit
      */
     public String getXml( HttpServletRequest request, Locale locale )
     {
         StringBuffer strXml = new StringBuffer( );
         XmlUtil.beginElement( strXml, TAG_DIGG_SUBMIT );
         XmlUtil.addElementHtml( strXml, TAG_DIGG_SUBMIT_DATE_RESPONSE,
                 DateUtil.getDateString( this.getDateResponse( ), locale ) );
         XmlUtil.addElementHtml( strXml, TAG_DIGG_SUBMIT_SCORE, Integer.toString( this.getNumberScore( ) ) );
         XmlUtil.addElementHtml( strXml, TAG_DIGG_SUBMIT_NUMBER_VOTE, Integer.toString( this.getNumberVote( ) ) );
         XmlUtil.addElementHtml( strXml, TAG_DIGG_SUBMIT_NUMBER_COMMENT, Integer.toString( this.getNumberComment( ) ) );
         XmlUtil.addElementHtml( strXml, TAG_DIGG_SUBMIT_CATEGORY, ( this.getCategory( ) != null ) ? this.getCategory( )
                 .getTitle( ) : DiggUtils.EMPTY_STRING );
         XmlUtil.addElementHtml( strXml, TAG_DIGG_SUBMIT_TYPE, ( this.getDiggSubmitType( ) != null ) ? this
                 .getDiggSubmitType( ).getName( ) : DiggUtils.EMPTY_STRING );
         XmlUtil.addElementHtml( strXml, TAG_DIGG_SUBMIT_TITLE, this.getDiggSubmitTitle( ) );
 
         XmlUtil.beginElement( strXml, TAG_DIGGS_SUBMIT_RESPONSES );
 
         if ( ( getResponses( ) != null ) && ( getResponses( ).size( ) != 0 ) )
         {
             HashMap<Integer, Response> hashResponsesEntry = new HashMap<Integer, Response>( );
 
             for ( Response response : getResponses( ) )
             {
                 hashResponsesEntry.put( response.getEntry( ).getIdEntry( ), response );
             }
 
             for ( IEntry entry : this.getDigg( ).getEntries( ) )
             {
                 if ( hashResponsesEntry.containsKey( entry.getIdEntry( ) ) )
                 {
                     strXml.append( hashResponsesEntry.get( entry.getIdEntry( ) ).getXml( request, locale ) );
                 }
                 else
                 {
                     //add xml empty response for this digg submit
                     Response responseEmpty = new Response( );
                     responseEmpty.setEntry( entry );
                     responseEmpty.setValueResponse( DiggUtils.EMPTY_STRING );
                     strXml.append( responseEmpty.getXml( request, locale ) );
                 }
             }
         }
 
         XmlUtil.endElement( strXml, TAG_DIGGS_SUBMIT_RESPONSES );
 
         XmlUtil.beginElement( strXml, TAG_DIGGS_SUBMIT_COMMENTS );
 
         if ( ( getComments( ) != null ) && ( getComments( ).size( ) != 0 ) )
         {
             for ( CommentSubmit commentSubmit : getComments( ) )
             {
                 strXml.append( commentSubmit.getXml( request, locale ) );
             }
         }
 
         XmlUtil.endElement( strXml, TAG_DIGGS_SUBMIT_COMMENTS );
 
         XmlUtil.endElement( strXml, TAG_DIGG_SUBMIT );
 
         return strXml.toString( );
     }
 
     /**
      * @param listComments the _listComments to set
      */
     public void setComments( List<CommentSubmit> listComments )
     {
         this._listComments = listComments;
     }
 
     /**
      * @return the _listComments
      */
     public List<CommentSubmit> getComments( )
     {
         return _listComments;
     }
 
     /**
      * @param nDiggSubmitOrder the _nDiggSubmitOrder to set
      */
     public void setDiggSubmitOrder( int nDiggSubmitOrder )
     {
         this._nDiggSubmitOrder = nDiggSubmitOrder;
     }
 
     /**
      * @return the _nDiggSubmitOrder
      */
     public int getDiggSubmitOrder( )
     {
         return _nDiggSubmitOrder;
     }
 
     /**
      * @param diggSubmitType the diggSubmitType to set
      */
     public void setDiggSubmitType( DiggSubmitType diggSubmitType )
     {
         this._diggSubmitType = diggSubmitType;
     }
 
     /**
      * @return the diggSubmitType
      */
     public DiggSubmitType getDiggSubmitType( )
     {
         return _diggSubmitType;
     }
 
     /**
      * 
      * @return true if the vote is disable
      */
     public boolean isDisableVote( )
     {
         return _bDisableVote;
     }
 
     /**
      * set true if the vote is disable
      * @param bDisable true if the vote is disable
      */
     public void setDisableVote( boolean bDisable )
     {
         _bDisableVote = bDisable;
     }
 
     /**
      * 
      * @return true if the vote is disable
      */
     public boolean isDisableComment( )
     {
         return _bDisableComment;
     }
 
     /**
      * set true if the vote is disable
      * @param bDisable true if the comment is disable
      */
     public void setDisableComment( boolean bDisable )
     {
         _bDisableComment = bDisable;
     }
 
     /**
      * 
      * @return true if the diggsubmit is pinned
      */
     public boolean isPinned( )
     {
         return _bPinned;
     }
 
     /**
      * 
      * @param bPinned true if the diggsubmit is pinned
      */
     public void setPinned( boolean bPinned )
     {
         this._bPinned = bPinned;
     }
 
     /**
      * 
      * @return the list of reported Messages
      */
     public List<ReportedMessage> getReportedMessages( )
     {
         return _listReportedMessages;
     }
 
     /**
      * set the list of reported Messages
      * @param listReportedMessages the list of reported Messages
      */
     public void setReportedMessages( List<ReportedMessage> listReportedMessages )
     {
         this._listReportedMessages = listReportedMessages;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getIdExtendableResource( )
     {
         return Integer.toString( _nIdDiggSubmit );
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getExtendableResourceType( )
     {
         return RESOURCE_TYPE;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getExtendableResourceName( )
     {
         return _strDiggSubmitTitle;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getExtendableResourceDescription( )
     {
         return _strDiggSubmitTitle;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getExtendableResourceImageUrl( )
     {
         if ( _nIdImageResource != null )
         {
             StringBuilder sbUrl = new StringBuilder( DiggUtils.SERVLET_IMAGE_PATH );
             sbUrl.append( _nIdImageResource );
 
             return sbUrl.toString( );
         }
 
         return null;
     }
 
     /**
      * the image id resource associate to the digg submit
      * @return the image id resource associate to the digg submit
      */
     public Integer getIdImageResource( )
     {
         return _nIdImageResource;
     }
 
     /**
      * set the image id resource associate to the digg submit
      * @param nIdImageRessource the image id resource associate to the digg
      *            submit
      */
     public void setIdImageResource( Integer nIdImageRessource )
     {
         this._nIdImageResource = nIdImageRessource;
     }
 }