/*
    * 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.spi.core.metadata.projectdoc.ProjectdocMetaData;
  import de.smartics.util.lang.Arguments;
  import de.smartics.util.lang.BlankArgumentException;
  import de.smartics.util.lang.NullArgumentException;
  
  /**
   * Report information for a particular property set.
   */
  public final class PropertyReportSet
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The name of the property set as read from the
     * {@link de.smartics.properties.api.core.annotations.PropertySet} annotation.
     */
    private final String name;
  
    /**
     * The type that defines the report set, if no name is specified explicitly.
     */
    private final String type;
  
    /**
     * The Javadoc comment to the descriptor.
     */
    private final String comment;
  
    /**
     * The document instance metadata.
     */
    private final DocumentMetaData metadata;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    private PropertyReportSet(final Builder builder)
    {
      this.name = builder.name;
      this.type = builder.type;
      this.comment = builder.comment;
      this.metadata = builder.metadata;
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * Builder to create instances of enclosing class.
     */
    public static final class Builder
    {
      // ******************************** Fields ********************************
  
      // --- constants ----------------------------------------------------------
  
      // --- members ------------------------------------------------------------
  
      /**
       * The name of the property set as read from the
       * {@link de.smartics.properties.api.core.annotations.PropertySet} annotation.
       */
      private String name;
  
      /**
       * The type that defines the report set, if no name is specified explicitly.
       */
      private String type;
  
      /**
       * The Javadoc comment to the descriptor.
       */
      private String comment;
  
      /**
      * The document instance metadata.
      */
     private DocumentMetaData metadata = new ProjectdocMetaData();
 
     // ***************************** Initializer ******************************
 
     // ***************************** Constructors *****************************
 
     // ***************************** Inner Classes ****************************
 
     // ******************************** Methods *******************************
 
     // --- init ---------------------------------------------------------------
 
     // --- get&set ------------------------------------------------------------
 
     /**
      * Sets the name of the property set as read from the
      * {@link de.smartics.properties.api.core.annotations.PropertySet} annotation.
      *
      * @param name the name of the property set.
      * @return a reference to the builder.
      */
     public Builder withPropertySetName(final String name)
     {
       this.name = name;
       return this;
     }
 
     /**
      * Sets the type that defines the report set, if no name is specified
      * explicitly.
      *
      * @param type the type that defines the report set, if no name is specified
      *          explicitly.
      * @return a reference to the builder.
      */
     public Builder withType(final String type)
     {
       this.type = type;
       return this;
     }
 
     /**
      * Sets the Javadoc comment to the descriptor.
      *
      * @param comment the Javadoc comment to the descriptor.
      * @return a reference to the builder.
      */
     public Builder withComment(final String comment)
     {
       this.comment = comment;
       return this;
     }
 
     /**
      * Set the document instance metadata.
      *
      * @param metadata the document instance metadata.
      * @return a reference to the builder.
      * @throws NullArgumentException if {@code metadata} is <code>null</code>.
      */
     public Builder with(final DocumentMetaData metadata)
       throws NullArgumentException
     {
       Arguments.checkNotNull("metadata", metadata);
       this.metadata = metadata;
       return this;
     }
 
     // --- business -----------------------------------------------------------
 
     /**
      * Creates the report item.
      *
      * @return the report item.
      */
     public PropertyReportSet build()
     {
       if (StringUtils.isBlank(type))
       {
         throw new BlankArgumentException("type",
             "Building property set failed.");
       }
       return new PropertyReportSet(this);
     }
 
     // --- object basics ------------------------------------------------------
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the type that defines the report set, if no name is specified
    * explicitly.
    *
    * @return the type that defines the report set, if no name is specified
    *         explicitly.
    */
   public String getType()
   {
     return type;
   }
 
   /**
    * Returns the Javadoc comment to the descriptor.
    *
    * @return the Javadoc comment to the descriptor.
    */
   public String getComment()
   {
     return comment;
   }
 
   /**
    * Returns the document instance metadata.
    *
    * @return the document instance metadata.
    */
   public DocumentMetaData getMetaData()
   {
     return metadata;
   }
 
   /**
    * Returns the name that uniquely identifies the property set report.
    *
    * @return the name that uniquely identifies the property set report.
    */
   public String getName()
   {
     if (StringUtils.isNotBlank(name))
     {
       return name;
     }
 
     final String metadataName = metadata.getName();
     if (StringUtils.isNotBlank(metadataName))
     {
       return metadataName;
     }
 
     return type;
   }
 
   /**
    * Returns the space the report item belongs to.
    *
    * @return the space the report item belongs to.
    */
   public String getSpace()
   {
     final String metadataSpace = metadata.getSpace();
     if (StringUtils.isNotBlank(metadataSpace))
     {
       return metadataSpace;
     }
 
     return "property-set:" + type;
   }
 
   /**
    * 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 metadataTitle = metadata.getTitle();
     if (StringUtils.isNotBlank(metadataTitle))
     {
       return metadataTitle;
     }
 
     return type;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }