/*
    * Copyright (c) 2002-2017, 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.business;
  
  import fr.paris.lutece.portal.service.plugin.Plugin;
  import fr.paris.lutece.util.xml.XmlUtil;
  import java.sql.Timestamp;
  
  import java.util.HashMap;
  import java.util.Locale;
  
  /**
   *
   * class File
   *
   */
  public class File
  {
      public static final String TAG_FILE = "file";
      private static final String ATTRIBUTE_FILE_ID = "id";
      private static final String ATTRIBUTE_TYPE_ENTRY = "type-entry";
      private static final String TAG_TITLE = "title";
      private static final String TAG_SIZE = "size";
      private static final String TAG_MIME_TYPE = "mime-type";
      private static final String TAG_HEIGHT = "height";
      private static final String TAG_WIDTH = "width";
      private int _nIdFile;
      private PhysicalFile _physicalFile;
      private String _strTitle;
      private int _nSize;
      private String _strExtension;
      private String _strMimeType;
      private Timestamp _dateExpiration;
  
      /**
       *
       * @return the id of the file
       */
      public int getIdFile( )
      {
          return _nIdFile;
      }
  
      /**
       * set the id of the file
       * 
       * @param idFile
       *            id of the file
       */
      public void setIdFile( int idFile )
      {
          _nIdFile = idFile;
      }
  
      /**
       *
       * @return the title of the file
       */
      public String getTitle( )
      {
          return _strTitle;
      }
  
      /**
       * set the title of the file
       * 
       * @param title
       *            the title of the file
      */
     public void setTitle( String title )
     {
         _strTitle = title;
     }
 
     /**
      *
      * @return the size of the file
      */
     public int getSize( )
     {
         return _nSize;
     }
 
     /**
      * set the size of the file
      * 
      * @param size
      *            the size of the file
      */
     public void setSize( int size )
     {
         _nSize = size;
     }
 
     /**
      *
      * @return the extension of the file
      */
     public String getExtension( )
     {
         return _strExtension;
     }
 
     /**
      * set the extension of the file
      * 
      * @param extension
      *            the title of the file
      */
     public void setExtension( String extension )
     {
         _strExtension = extension;
     }
 
     /**
      *
      * @return the extension of the file
      */
     public String getMimeType( )
     {
         return _strMimeType;
     }
 
     /**
      * set the mime type of the file
      * 
      * @param mimeType
      *            the mime type of the file
      */
     public void setMimeType( String mimeType )
     {
         _strMimeType = mimeType;
     }
 
     /**
      *
      * @return the PhysicalFile associate to the file
      */
     public PhysicalFile getPhysicalFile( )
     {
         return _physicalFile;
     }
 
     /**
      * set the PhysicalFile associate to the file
      * 
      * @param file
      *            PhysicalFile
      */
     public void setPhysicalFile( PhysicalFile file )
     {
         _physicalFile = file;
     }
 
     /**
      * return the xml of file
      * 
      * @param plugin
      *            the plugin
      * @param locale
      *            the locale
      * @param nTypeEntry
      *            The entry type
      * @param nWidth
      *            The width
      * @param nHeight
      *            The height
      * @return The produced xml
      */
     public StringBuffer getXml( Plugin plugin, Locale locale, int nTypeEntry, int nWidth, int nHeight )
     {
         StringBuffer strXml = new StringBuffer( );
         HashMap<String, Object> model = new HashMap<String, Object>( );
         model.put( ATTRIBUTE_FILE_ID, String.valueOf( getIdFile( ) ) );
         model.put( ATTRIBUTE_TYPE_ENTRY, String.valueOf( nTypeEntry ) );
         XmlUtil.beginElement( strXml, TAG_FILE, model );
         XmlUtil.addElementHtml( strXml, TAG_TITLE, getTitle( ) );
         XmlUtil.addElement( strXml, TAG_SIZE, getSize( ) );
         XmlUtil.addElement( strXml, TAG_MIME_TYPE, getMimeType( ) );
         XmlUtil.addElement( strXml, TAG_WIDTH, nWidth );
         XmlUtil.addElement( strXml, TAG_HEIGHT, nHeight );
         XmlUtil.endElement( strXml, TAG_FILE );
 
         return strXml;
     }
 
     /**
      * Get the expiration date of the file
      * 
      * @return the expiration date of the file
      */
     public Timestamp getDateExpiration( )
     {
         return _dateExpiration;
     }
 
     /**
      * Set the expiration date of the file
      * 
      * @param _dateExpiration
      *            the expiration date of the file
      */
     public void setDateExpiration( Timestamp _dateExpiration )
     {
         this._dateExpiration = _dateExpiration;
     }
 
     /**
      * Return true if the file as expired, false otherwise
      * 
      * @return true if the file has expired
      */
     public boolean isFileExpired( )
     {
         return _dateExpiration.after( new Timestamp( System.currentTimeMillis( ) ) );
     }
 
 }