/*
    * Copyright 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.admin.resources.representation.xml;
  
  import java.io.IOException;
  import java.io.OutputStream;
  import java.util.List;
  import java.util.Locale;
  
  import de.smartics.properties.admin.resources.representation.share.BreadcrumbHelper;
  import de.smartics.properties.admin.resources.representation.xml.share.AbstractXmlRepresentationRenderer;
  import de.smartics.properties.api.core.domain.PropertyComment;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.api.core.domain.PropertyProjectdoc;
  import de.smartics.properties.api.core.domain.SourceInfo;
  import de.smartics.properties.report.data.PropertyReportItem;
  import de.smartics.properties.reports.XmlPropertyItemReport;
  import de.smartics.resteasy.hypermedia.renderer.LinkDescriptor;
  import de.smartics.resteasy.hypermedia.renderer.ResourceContext;
  
  /**
   * Displays a selected property descriptor as SDoc XML.
   */
  public final class PropertyDescriptorXmlRepresentationRenderer extends
      AbstractXmlRepresentationRenderer<PropertyDescriptor>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The domain object to render.
     */
    private final PropertyDescriptor domainObject;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param context the context information to render the representation.
     * @param domainObject the domain object to render.
     * @param entityStream the stream to write to.
     */
    public PropertyDescriptorXmlRepresentationRenderer(
        final ResourceContext context, final PropertyDescriptor domainObject,
        final OutputStream entityStream)
    {
      super(context, entityStream);
      this.domainObject = domainObject;
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    @Override
    protected void httpBody()
    {
      final XmlPropertyItemReport report =
          new XmlPropertyItemReport(characterEncoding);
  
      final PropertyReportItem reportItem = createReportItem();
      try
      {
        report.write(reportItem, entityStream);
      }
      catch (final IOException e)
      {
        // TODO: How should we signal this? Separate exception?
        throw new IllegalStateException("Cannot render to the stream.", e);
      }
    }
  
    private PropertyReportItem createReportItem()
    {
     final PropertyReportItem.Builder builder = new PropertyReportItem.Builder();
 
     final Locale locale = context.getL7nProvider().getLocale();
     final PropertyProjectdoc projectdoc =
         domainObject.getDocumentMetaData(locale);
     final SourceInfo sourceInfo = projectdoc.getSourceInfo();
     final PropertyComment propertyComment = projectdoc.getComment();
     builder.with(domainObject).with(sourceInfo).with(propertyComment);
 
     final PropertyReportItem reportItem = builder.build();
     return reportItem;
   }
 
   @Override
   protected List<LinkDescriptor> hyperLinks()
   {
     return BreadcrumbHelper.adjustSelf(breadcrumb.descriptor(domainObject
         .getKey().toString()));
   }
 
   @Override
   protected void close()
   {
   }
 
   // --- object basics --------------------------------------------------------
 
 }