/*
    * Copyright 2010-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package de.smartics.testdoc.core.adapter;
  
  import java.io.File;
  import java.io.FilenameFilter;
  import java.util.List;
  
  import de.smartics.testdoc.core.doc.ScenarioTestDoc;
  import de.smartics.testdoc.core.doc.Type;
  import de.smartics.testdoc.core.doc.UnitTestDoc;
  import de.smartics.testdoc.core.export.AbstractExportAdapter;
  import de.smartics.testdoc.core.export.ExportException;
  
  /**
   * Exports the documentation fragments to a directory via the APT filer.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public abstract class AbstractFileBasedExportAdapter extends
      AbstractExportAdapter
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * Helper to serialize instances of {@link UnitTestDoc} to files.
     */
    protected final PersistenceUtils persist = new PersistenceUtils();
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    public AbstractFileBasedExportAdapter()
    {
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * {@inheritDoc}
     *
     * @see de.smartics.testdoc.core.export.ExportAdapter#export(de.smartics.testdoc.core.doc.UnitTestDoc)
     */
    @Override
    public void export(final UnitTestDoc testDoc) throws ExportException
    {
      final Type testCaseType = calcTestCaseType(testDoc);
      if (testCaseType != null)
      {
        try
        {
          final Type uutType = testDoc.getUutType();
          final File file = createFileRef(testCaseType, uutType);
          if (file.exists())
          {
            final UnitTestDoc storedTestDoc =
                (UnitTestDoc) persist.deserialize(file);
            storedTestDoc.addScenarios(testDoc);
            persist.serialize(storedTestDoc, file);
          }
          else
          {
            persist.serialize(testDoc, file);
          }
        }
        catch (final IllegalStateException e)
        {
          throw new IllegalStateException(
              "Cannot create resource with APT filer.", e);
       }
     }
   }
 
   protected abstract File createFileRef(final Type testCaseType,
       final Type uutType) throws IllegalStateException;
 
   protected abstract File[] createFileRefs(final Type testCaseType)
     throws IllegalStateException;
 
   protected final File[] createFileRefs(final Type testCaseType, final File directory)
   {
     final String prefix = testCaseType.toString() + '-';
     final File[] files = directory.listFiles(new FilenameFilter()
     {
       @Override
       public boolean accept(final File dir, final String name)
       {
         return name.startsWith(prefix);
       }
     });
     if (files != null)
     {
       return files;
     }
     return new File[0];
   }
 
   /**
    * Assumes that all scenarios belong to the same test case type.
    */
   protected final Type calcTestCaseType(final UnitTestDoc testDoc)
   {
     final List<ScenarioTestDoc> scenarios = testDoc.getScenarios();
     if (!scenarios.isEmpty())
     {
       final Type testCaseType = scenarios.get(0).getTestCaseType();
       for (final ScenarioTestDoc scenario : scenarios)
       {
         final Type currentType = scenario.getTestCaseType();
         if (!testCaseType.equals(currentType))
         {
           throw new IllegalArgumentException("Not all scenarios are of type '"
                                              + testCaseType + "': "
                                              + currentType);
         }
       }
       return testCaseType;
     }
     return null;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.testdoc.core.export.ExportAdapter#clear(de.smartics.testdoc.core.doc.Type)
    */
   @Override
   public void clear(final Type testCaseType)
   {
     if (testCaseType != null)
     {
       try
       {
         final File[] fileRefs = createFileRefs(testCaseType);
         for (final File file : fileRefs)
         {
           if (file.exists())
           {
             final UnitTestDoc testDoc = (UnitTestDoc) persist.deserialize(file);
             testDoc.removeScenarios(testCaseType);
             persist.serialize(testDoc, file);
           }
         }
       }
       catch (final IllegalStateException e)
       {
         throw new ExportException("Cannot clear scenarios for test case type '"
                                   + testCaseType + "'.", e);
       }
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }