/*

  * Copyright 2012-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.properties.reports;

 import java.io.IOException;

 import java.io.OutputStream;

 import org.apache.commons.io.IOUtils;

 import de.smartics.properties.report.app.ReportException;

 import de.smartics.properties.report.data.PropertyReportItem;

 import de.smartics.properties.report.data.PropertyReportSet;

 import de.smartics.util.io.StreamHandler;

 import de.smartics.util.lang.Arg;

 /**

  * Writes each report to a file.

  */

 public final class XmlPropertyReport extends AbstractPropertyReport

 {

   // ********************************* Fields *********************************

   // --- constants ------------------------------------------------------------

   // --- members --------------------------------------------------------------

   /**

    * The encoding used to write to the stream.

    */

   private final String encoding;

   /**

    * The location for property set reports being written to.

    */

   private final StreamHandler propertySetReportsRootDir;

   /**

    * The location for property reports being written to.

    */

   private final StreamHandler propertyReportsRootDir;

   // ****************************** Initializer *******************************

   // ****************************** Constructors ******************************

   /**

    * Constructor using UTF-8 as encoding.

    *

    * @param propertySetReportsRootDir the location for property set reports

    *          being written to.

    * @param propertyReportsRootDir the location for property reports being

    *          written to.

    * @throws NullPointerException if {@code propertySetReportsRootDir} or

    *           {@code propertyReportsRootDir} is <code>null</code>.

    */

   public XmlPropertyReport(final StreamHandler propertySetReportsRootDir,

       final StreamHandler propertyReportsRootDir) throws NullPointerException

   {

     this("UTF-8", propertySetReportsRootDir, propertyReportsRootDir);

   }

   /**

    * Default constructor.

    *

    * @param encoding the encoding used to write to the stream.

    * @param propertySetReportsRootDir the location for property set reports

    *          being written to.

    * @param propertyReportsRootDir the location for property reports being

    *          written to.

    * @throws NullPointerException if {@code encoding},

    *           {@code propertySetReportsRootDir} or

    *           {@code propertyReportsRootDir} is <code>null</code>.

    * @throws IllegalArgumentException if {@code encoding} is blank.

    */

   public XmlPropertyReport(final String encoding,

       final StreamHandler propertySetReportsRootDir,

       final StreamHandler propertyReportsRootDir) throws NullPointerException,

     IllegalArgumentException

   {

     this.encoding = Arg.checkNotBlank("encoding", encoding);

     this.propertySetReportsRootDir =

         Arg.checkNotNull("propertySetReportsRootDir", propertySetReportsRootDir);

     this.propertyReportsRootDir =

         Arg.checkNotNull("propertyReportsRootDir", propertyReportsRootDir);

   }

   // ****************************** Inner Classes *****************************

   // ********************************* Methods ********************************

   // --- init -----------------------------------------------------------------

   // --- get&set --------------------------------------------------------------

   // --- business -------------------------------------------------------------

   @Override

   public void handle(final PropertyReportSet reportSet) throws ReportException

   {

     final String resourceId = reportSet.getName() + ".xml";

     OutputStream out = null;

     try

     {

       out = propertySetReportsRootDir.openToWrite(resourceId);

       final XmlPropertySetReporter reporter =

           new XmlPropertySetReporter(encoding, reportSet);

       reporter.write(out);

     }

     catch (final IOException e)

     {

       throw new ReportException("Cannot write report '" + resourceId + "'.", e);

     }

     finally

     {

       IOUtils.closeQuietly(out);

     }

   }

   @Override

   public void handle(final PropertyReportItem item) throws ReportException

   {

     super.handle(item);

     final String resourceId = item.getName() + ".xml";

     OutputStream out = null;

     try

     {

       out = propertyReportsRootDir.openToWrite(resourceId);

       final XmlPropertyReporter reporter =

           new XmlPropertyReporter(encoding, item);

       reporter.write(out);

     }

     catch (final IOException e)

     {

       throw new ReportException("Cannot write report '" + resourceId + "'.", e);

     }

     finally

     {

       IOUtils.closeQuietly(out);

     }

   }

   // --- object basics --------------------------------------------------------

 }