/*
    * 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.html;
  
  import static de.smartics.properties.admin.domain.model.AppRelations.DESCRIPTOR;
  
  import java.io.OutputStream;
  import java.net.URI;
  import java.util.List;
  
  import org.apache.commons.lang.StringUtils;
  
  import de.smartics.html5.jatl.HtmlResourceContext;
  import de.smartics.properties.admin.resources.controller.PropertyDescriptorResource;
  import de.smartics.properties.admin.resources.representation.html.share.AbstractHtmlRepresentationRenderer;
  import de.smartics.properties.api.core.domain.PropertyCategories;
  import de.smartics.properties.api.core.domain.PropertyConstraint;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.spi.core.constraints.PropertyRangeConstraint;
  import de.smartics.resteasy.hypermedia.renderer.LinkDescriptor;
  import de.smartics.util.lang.StringFunction;
  
  /**
   * Displays a selected property descriptor.
   */
  public final class PropertyDescriptorHtmlRepresentationRenderer extends
      AbstractHtmlRepresentationRenderer<PropertyDescriptor>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The title to the page.
     */
    private static final String TITLE = "Property Descriptor";
  
    // --- members --------------------------------------------------------------
  
    /**
     * The domain object to render.
     */
    private final PropertyDescriptor domainObject;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param htmlContext the context information to render the representation.
     * @param domainObject the domain object to render.
     * @param entityStream the stream to write to.
     */
    public PropertyDescriptorHtmlRepresentationRenderer(
        final HtmlResourceContext htmlContext,
        final PropertyDescriptor domainObject, final OutputStream entityStream)
    {
      super(htmlContext, entityStream);
      this.domainObject = domainObject;
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    @Override
    protected String getTitle()
    {
      return TITLE;
    }
  
    // --- business -------------------------------------------------------------
  
    @Override
    protected void bodyContents()
    {
      renderPageTitle(domainObject.getKey().toString());
  
      final String htmlFragment = domainObject.getComment().getText();
      final String normalized = htmlUtils.cleanHtmlAndJavadoc(htmlFragment);
     html.p().raw(normalized).end();
 
     descriptorInformation();
   }
 
   private void descriptorInformation()
   {
     html.table().classAttr("table table-striped table-bordered");
     html.tr().th().text("name").end().th().text("value").end().end();
     renderRow("mandatory", domainObject.isMandatory());
     renderRow("access type", domainObject.getAccessType());
     renderRow("use type", domainObject.getUseType().toString());
     renderRow("categories", toString(domainObject.getCategories()));
     renderRow("configuration time", domainObject.getConfigurationTime());
     renderRow("update interval", domainObject.getUpdateIntervalInMs());
     renderRow("default expression", domainObject.getDefaultExpression());
     renderRow("value type", domainObject.getType());
     renderRow("value range", domainObject.getValueRange());
     renderRow("constraints", toString(domainObject.getConstraints()));
     renderRow("declaring type", domainObject.getDeclaringType().getName());
     renderRow("home page", domainObject.getContext().getHomePageUrl());
     final String reportUrl =
         domainObject.getContext().getPropertiesContext()
             .createReportUrl(domainObject);
     renderRow("Report", reportUrl);
     html.end();
 
     html.p();
     final String key = domainObject.getKey().toString();
     final URI url = createDownloadUrl(key);
     html.a().id("asXml").rel(DESCRIPTOR).href(url.toString())
         .icon("icon-download-alt").text(" Download as XML").end();
     html.end();
   }
 
   private URI createDownloadUrl(final String key)
   {
     final URI url =
         htmlContext.getContext().getUriInfo().getBaseUriBuilder()
             .path(PropertyDescriptorResource.class, "getAsDotXml")
             .build(new Object[] { key }, false);
     return url;
   }
 
   private void renderRow(final String label, final Object value)
   {
     if (isNotBlank(value))
     {
       html.tr();
       html.td().text(label).end().td().text(String.valueOf(value)).end();
       html.end();
     }
   }
 
   private boolean isNotBlank(final Object value)
   {
     if (value == null)
     {
       return false;
     }
 
     return StringUtils.isNotBlank(String.valueOf(value));
   }
 
   private String toString(final PropertyCategories categories)
   {
     final List<Class<?>> types = categories.getCategories();
     final StringBuilder buffer = new StringBuilder(64);
     for (final Class<?> type : types)
     {
       buffer.append(type.getName()).append(' ');
     }
     return StringFunction.chop(buffer).toString();
   }
 
   private Object toString(
       final List<? extends PropertyConstraint<?>> constraints)
   {
     final StringBuilder buffer = new StringBuilder(64);
 
     for (final Object constraint : constraints)
     {
       if (constraint instanceof PropertyRangeConstraint)
       {
         continue;
       }
       buffer.append(' ').append(constraint);
     }
 
     return buffer.toString();
   }
 
   @Override
   protected List<LinkDescriptor> breadcrumbLinks()
   {
     return breadcrumb.descriptor(domainObject.getKey().toString());
   }
 
   // --- object basics --------------------------------------------------------
 
 }