/*
    * $Id: AbstractGHFile.java 2993 2011-11-24 19:51:48Z andrewinkler $
    * ============================================================================
    * Project gluehloch-homepage-core
    * Copyright (c) 2004-2010 by Andre Winkler. All rights reserved.
    * ============================================================================
    *          GNU LESSER GENERAL PUBLIC LICENSE
    *  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
    *
   *  This library is free software; you can redistribute it and/or
   *  modify it under the terms of the GNU Lesser General Public
   *  License as published by the Free Software Foundation; either
   *  version 2.1 of the License, or (at your option) any later version.
   *
   *  This library is distributed in the hope that it will be useful,
   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   *  Lesser General Public License for more details.
   *
   *  You should have received a copy of the GNU Lesser General Public
   *  License along with this library; if not, write to the Free Software
   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   *
   */
  
  package de.awtools.homegen.directory.utils;
  
  import java.io.File;
  import java.util.List;
  
  import org.apache.commons.io.FilenameUtils;
  
  import de.awtools.homegen.directory.FileType;
  import de.awtools.homegen.directory.GHDirectory;
  import de.awtools.homegen.directory.GHFile;
  
  /**
   * Utility Klasse für {@link GHFile} Implementierungen.
   *
   * @version $LastChangedRevision: 2993 $ $LastChangedDate: 2011-11-24 20:51:48 +0100 (Thu, 24 Nov 2011) $
   * @author by Andre Winkler, $LastChangedBy: andrewinkler $
   */
  public abstract class AbstractGHFile extends AbstractGHEntry implements GHFile {
  
      /**
       * Konstruktor.
       *
       * @param _file Die zugeordnete Datei.
       * @param _directory Das zugeordnete Verzeichnis.
       * @param _name Der Name für die zugeordnete Datei.
       */
      protected AbstractGHFile(final File _file, final GHDirectory _directory,
              final String _name) {
  
          file = _file;
          snippetDirectory = _directory;
          name = _name;
  
          if (!name.startsWith("/")) {
              throw new IllegalStateException("name of file '" + name
                      + "' must start with a '/'");
          }
  
          fileType = FileType.findType(_name);
      }
  
      // -- name ----------------------------------------------------------------
  
      /** Der Name der zugeordneten Datei. */
      private final String name;
  
      /**
       * Der Name für die Datei.
       *
       * @return Dateiname.
       */
      @Override
      public final String getName() {
          return name;
      }
  
      /**
       * Liefert den Pfad für diese Datei. An dem Pfad ist nicht der Dateiname
       * angehangen. Dafür ist {@link #getNameAndPath()} zu verwenden.
       *
       * @see de.awtools.homegen.directory.GHEntry#getPath()
       */
      @Override
      public final String getPath() {
          return getDirectory().getPath();
      }
  
      /**
       * Liefert den {@link GHDirectory} Pfad von der Wurzel bis zu diesem
       * Eintrag.
       *
       * @return Eine Liste mit dem {@link GHDirectory}-Pfad von der Wurzel bis
       *     zu diesem Eintrag.
       */
     @Override
     public final List<GHDirectory> getDirectoryPath() {
         return getDirectory().getDirectoryPath();
     }
 
     /**
      * Liefert den Name plus den Verzeichnispfad von der Wurzel an abwärts.
      *
      * @return Datei und Pfadname.
      */
     @Override
     public final String getNameAndPath() {
         StringBuilder sb = new StringBuilder();
         sb.append(getDirectory().getPath());
         sb.append(name);
         return sb.toString();
     }
 
     /**
      * Liefert den Namen der Datei ohne Extension, d.h. der Name ohne den
      * Zusatz, der nach '.' erscheint.
      *
      * @return Der Name der Datei ohne Extension.
      */
     @Override
     public final String getNameWithoutExtension() {
         return FilenameUtils.removeExtension(getName());
     }
 
     /**
      * Liefert die Extension der Datei, d.h. alles was nach dem letzten '.'
      * im Namen steht.
      *
      * @return Die Datei-Extension.
      */
     @Override
     public final String getExtension() {
         return FilenameUtils.getExtension(getName());
     }
 
     // -- file ----------------------------------------------------------------
 
     /** Das zugeordnete <code>File</code> Objekt. */
     private final File file;
 
     /**
      * Liefert das <code>File</code> Objekt für dies Datei. Für das
      * Maven-Homepage-Plugin ist dies i.d.R. das Verzeichnis
      * <code>target/www-prep</code>.
      *
      * @return Das <code>File</code> Objekt zu dieser Datei.
      */
     @Override
     public final File getFile() {
         return file;
     }
 
     // -- directory -----------------------------------------------------------
 
     /** Das zugeordnete Verzeichnis. */
     private final GHDirectory snippetDirectory;
 
     /**
      * Liefert das zugeordnete Verzeichnis.
      *
      * @return Das zugeordnete Verzeichnis.
      */
     @Override
     public final GHDirectory getDirectory() {
         return snippetDirectory;
     }
 
     // -- fileType ------------------------------------------------------------
 
     /** Der Dateityp. */
     private final FileType fileType;
 
     /**
      * Liefert den Dateityp.
      *
      * @return Der Dateityp.
      */
     @Override
     public final FileType getFileType() {
         return fileType;
     }
 
     // -- level ---------------------------------------------------------------
 
     /**
      * @return Die Anzahl der Verzeichnisstufen bis in das Wurzelverzeichnis.
      *
      * @see de.awtools.homegen.directory.GHDirectory#getLevelFromRoot()
      */
     @Override
     public final int getLevelFromRoot() {
         return snippetDirectory.getLevelFromRoot();
     }
 
     @Override
     public final String printGraph() {
         StringBuilder spaces = new StringBuilder();
         for (int tab = 0; tab < getLevelFromRoot(); tab++) {
             spaces.append("  ");
         }
         return spaces.append("  |-- ").append(getName()).append("\r\n")
                 .toString();
     }
 
     // ------------------------------------------------------------------------
 
     @Override
     public String toString() {
         StringBuilder sb = new StringBuilder("[File='");
         sb.append(getNameAndPath());
         sb.append("']");
         return sb.toString();
     }
 
     @Override
     public boolean equals(final Object _object) {
         boolean result = false;
         if (_object instanceof AbstractGHFile) {
             AbstractGHFile aghf = (AbstractGHFile) _object;
             result = (getNameAndPath().equals(aghf.getNameAndPath()));
         }
         return result;
     }
 
     @Override
     public int hashCode() {
         return (getNameAndPath().hashCode());
     }
 
 }