/*
    * 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.report.data;
  
  import org.apache.commons.lang.StringUtils;
  
  import de.smartics.properties.api.core.domain.DocumentMetaData;
  import de.smartics.properties.api.core.domain.PropertyComment;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.api.core.domain.PropertyValueComment;
  import de.smartics.properties.api.core.domain.SourceInfo;
  import de.smartics.util.lang.Arg;
  
  /**
   * Report information for a particular property.
   */
  public final class PropertyReportItem
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The descriptor to the property.
     */
    private final PropertyDescriptor descriptor;
  
    /**
     * The Javadoc comment to the descriptor.
     */
    private final PropertyComment comment;
  
    /**
     * The information about the source the property was defined in.
     */
    private final SourceInfo sourceInfo;
  
    /**
     * The optional value in case this is a runtime report.
     */
    private Object value;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    private PropertyReportItem(final Builder builder)
    {
      this.descriptor = builder.descriptor;
      this.comment = builder.comment;
      this.sourceInfo = builder.sourceInfo;
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * Builder to create instances of enclosing class.
     */
    public static final class Builder
    {
      // ******************************** Fields ********************************
  
      // --- constants ----------------------------------------------------------
  
      // --- members ------------------------------------------------------------
  
      /**
       * The descriptor to the property.
       */
      private PropertyDescriptor descriptor;
  
      /**
       * The Javadoc comment to the descriptor.
       */
      private PropertyComment comment;
  
      /**
       * The information about the source the property was defined in.
       */
      private SourceInfo sourceInfo;
  
      // ***************************** Initializer ******************************
  
      // ***************************** Constructors *****************************
 
     // ***************************** Inner Classes ****************************
 
     // ******************************** Methods *******************************
 
     // --- init ---------------------------------------------------------------
 
     // --- get&set ------------------------------------------------------------
 
     /**
      * Sets the descriptor to the property.
      *
      * @param descriptor the descriptor to the property.
      * @return a reference to the builder.
      */
     public Builder with(final PropertyDescriptor descriptor)
     {
       this.descriptor = descriptor;
       return this;
     }
 
     /**
      * Sets the property comment.
      *
      * @param comment the comment to this property.
      * @return a reference to the builder.
      */
     public Builder with(final PropertyComment comment)
     {
       this.comment = comment;
       return this;
     }
 
     /**
      * Sets the information about the source the property was defined in.
      *
      * @param sourceInfo the information about the source the property was
      *          defined in.
      * @return a reference to the builder.
      */
     public Builder with(final SourceInfo sourceInfo)
     {
       this.sourceInfo = sourceInfo;
       return this;
     }
 
     // --- business -----------------------------------------------------------
 
     /**
      * Creates the report item.
      *
      * @return the report item.
      */
     public PropertyReportItem build()
     {
       Arg.checkNotNull("descriptor", descriptor);
 
       if (comment == null)
       {
         comment = new PropertyComment.Builder().build();
       }
       if (sourceInfo == null)
       {
         sourceInfo = SourceInfo.EMPTY;
       }
       return new PropertyReportItem(this);
     }
 
     // --- object basics ------------------------------------------------------
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the descriptor to the property.
    *
    * @return the descriptor to the property.
    */
   public PropertyDescriptor getDescriptor()
   {
     return descriptor;
   }
 
   /**
    * Returns the Javadoc comment to the descriptor.
    *
    * @return the Javadoc comment to the descriptor.
    */
   public PropertyComment getComment()
   {
     return comment;
   }
 
   /**
    * Returns the property comment.
    * <p>
    * If the {@link #getComment() comment} is <code>null</code>, this method
    * returns safely <code>null</code>.
    * </p>
    *
    * @return the property comment.
    */
   public String getCommentText()
   {
     if (comment != null)
     {
       return comment.getText();
     }
     return null;
   }
 
   /**
    * Returns the property value comment.
    * <p>
    * If the {@link #getComment() comment} is <code>null</code>, this method
    * returns safely <code>null</code>.
    * </p>
    *
    * @return the property value comment.
    */
   public PropertyValueComment getValueComment()
   {
     if (comment != null)
     {
       return comment.getValueComment();
     }
     return null;
   }
 
   /**
    * Returns the information about the source the property was defined in.
    *
    * @return the information about the source the property was defined in.
    */
   public SourceInfo getSourceInfo()
   {
     return sourceInfo;
   }
 
   /**
    * Returns the document instance metadata.
    *
    * @return the document instance metadata.
    */
   public DocumentMetaData getMetaData()
   {
     return descriptor.getDocumentMetaData();
   }
 
   /**
    * Returns the optional value in case this is a runtime report.
    *
    * @return the optional value in case this is a runtime report.
    */
   public Object getValue()
   {
     return value;
   }
 
   /**
    * Sets the optional value in case this is a runtime report.
    *
    * @param value the optional value in case this is a runtime report.
    */
   public void setValue(final Object value)
   {
     this.value = value;
   }
 
   /**
    * Returns the name that uniquely identifies the property report within the
    * report set.
    *
    * @return the name that uniquely identifies the property report within the
    *         report set.
    */
   public String getLocalName()
   {
     final String metadataValue = descriptor.getDocumentMetaData().getName();
     if (StringUtils.isBlank(metadataValue))
     {
       return descriptor.getDocumentName().getName();
     }
 
     return metadataValue;
   }
 
   /**
    * Returns the name that uniquely identifies the property report document.
    *
    * @return the name that uniquely identifies the property report document.
    */
   public String getName()
   {
     // final String set = getPropertySet();
     final String name = getLocalName();
     // final String id = set + '.' + name;
     return name;
   }
 
   /**
    * Returns the space the report item belongs to.
    *
    * @return the space the report item belongs to.
    */
   public String getSpace()
   {
     final String metadataValue = descriptor.getDocumentMetaData().getSpace();
     if (StringUtils.isBlank(metadataValue))
     {
       return "property:" + sourceInfo.getElementTypeName();
     }
 
     return metadataValue;
   }
 
   /**
    * Returns the unique title of the report within the space.
    *
    * @return the unique title of the report within the space.
    */
   public String getTitle()
   {
     final String metadataValue = descriptor.getDocumentMetaData().getTitle();
 
     if (StringUtils.isBlank(metadataValue))
     {
       return descriptor.getKey().toString();
     }
 
     return metadataValue;
   }
 
   /**
    * Returns the set of properties this property belongs to.
    *
    * @return the set of properties this property belongs to.
    */
   public String getPropertySet()
   {
     final String descriptorValue = descriptor.getKey().getPropertySet();
     if (StringUtils.isBlank(descriptorValue))
     {
       return sourceInfo.getElementTypeName();
     }
 
     return descriptorValue;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }