/**
    * This file Copyright (c) 2003-2010 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.module.blossom.paragraph;
  
  import info.magnolia.module.blossom.annotation.I18nBasename;
  import info.magnolia.module.blossom.annotation.Paragraph;
  import info.magnolia.module.blossom.annotation.ParagraphDescription;
  import info.magnolia.module.blossom.annotation.TabOrder;
  import info.magnolia.module.blossom.dialog.DialogFactoryMetaData;
  import info.magnolia.module.blossom.dispatcher.BlossomDispatcher;
  import org.apache.commons.lang.StringUtils;
  
  /**
   * Builds paragraph descriptions from annotations.
   */
  public class ParagraphDescriptionBuilder {
  
      public BlossomParagraphDescription buildDescription(BlossomDispatcher dispatcher, Object handler, String handlerPath) {
  
          Paragraph annotation = handler.getClass().getAnnotation(Paragraph.class);
          I18nBasename i18nBasename = handler.getClass().getAnnotation(I18nBasename.class);
  
          BlossomParagraphDescription description = new BlossomParagraphDescription();
          description.setName(resolveName(handlerPath, handler, annotation));
          description.setTitle(resolveTitle(handlerPath, handler, annotation));
          description.setDescription(resolveDescription(handlerPath, handler, annotation));
          description.setHandlerPath(handlerPath);
          description.setI18nBasename(i18nBasename != null ? i18nBasename.value() : null);
          description.setHandler(handler);
          description.setDispatcher(dispatcher);
          description.setDialogName(StringUtils.trimToNull(annotation.dialog()));
  
          if (description.getDialogName() == null) {
              TabOrder tabOrder = handler.getClass().getAnnotation(TabOrder.class);
              DialogFactoryMetaData factoryMetaData = new DialogFactoryMetaData();
              factoryMetaData.setLabel(description.getTitle());
              factoryMetaData.setI18nBasename(description.getI18nBasename());
              factoryMetaData.setFactoryObject(handler);
              factoryMetaData.setTabOrder(tabOrder != null ? tabOrder.value() : null);
              description.setDialogFactoryMetaData(factoryMetaData);
          }
  
          return description;
      }
  
      protected String resolveName(String handlerPath, Object handler, Paragraph annotation) {
          if (StringUtils.isNotEmpty(annotation.name()))
              return annotation.name();
          return StringUtils.replaceChars(StringUtils.strip(handlerPath, "/"), '/', '_');
      }
  
      protected String resolveTitle(String handlerPath, Object handler, Paragraph annotation) {
          if (StringUtils.isNotEmpty(annotation.value()))
              return annotation.value();
          return handlerPath;
      }
  
      protected String resolveDescription(String handlerPath, Object handler, Paragraph annotation) {
          ParagraphDescription paragraphDescription = handler.getClass().getAnnotation(ParagraphDescription.class);
          if (paragraphDescription != null && StringUtils.isNotEmpty(paragraphDescription.value()))
              return paragraphDescription.value();
          return "";
      }
  }