// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you 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 org.apache.juneau.html;

import static org.apache.juneau.internal.ClassUtils.*;

import org.apache.juneau.*;
import org.apache.juneau.html.annotation.*;

/**
 * Metadata on bean properties specific to the HTML serializers and parsers pulled from the {@link Html @Html}
 * annotation on the bean property.
 */
@SuppressWarnings("rawtypes")
public final class HtmlBeanPropertyMeta extends ExtendedBeanPropertyMeta {

   /**
    * Default instance.
    */
   public static final HtmlBeanPropertyMeta DEFAULT = new HtmlBeanPropertyMeta();

   private final boolean noTables, noTableHeaders;
   private final HtmlFormat format;
   private final HtmlRender render;
   private final String link, anchorText;

   /**
    * Constructor.
    *
    * @param bpm The metadata of the bean property of this additional metadata.
    * @param mp HTML metadata provider (for finding information about other artifacts).
    */
   public HtmlBeanPropertyMeta(BeanPropertyMeta bpm, HtmlMetaProvider mp) {
      super(bpm);

      Builder b = new Builder();
      if (bpm.getInnerField() != null)
         for (Html html : mp.getAnnotations(Html.class, bpm.getInnerField()))
            b.findHtmlInfo(html);
      if (bpm.getGetter() != null)
         for (Html html : mp.getAnnotations(Html.class, bpm.getGetter()))
            b.findHtmlInfo(html);
      if (bpm.getSetter() != null)
         for (Html html : mp.getAnnotations(Html.class, bpm.getSetter()))
            b.findHtmlInfo(html);

      this.format = b.format;
      this.noTables = b.noTables;
      this.noTableHeaders = b.noTableHeaders;
      this.render = castOrCreate(HtmlRender.class, b.render);
      this.link = b.link;
      this.anchorText = b.anchorText;
   }

   private HtmlBeanPropertyMeta() {
      super(null);
      this.format = HtmlFormat.HTML;
      this.noTables = false;
      this.noTableHeaders = false;
      this.render = null;
      this.link = null;
      this.anchorText = null;
   }

   static final class Builder {
      boolean noTables, noTableHeaders;
      HtmlFormat format = HtmlFormat.HTML;
      Class<? extends HtmlRender> render = HtmlRender.class;
      String link, anchorText;

      void findHtmlInfo(Html html) {
         if (html == null)
            return;
         format = html.format();
         if (html.noTables())
            noTables = html.noTables();
         if (html.noTableHeaders())
            noTableHeaders = html.noTableHeaders();
         if (html.render() != HtmlRender.class)
            render = html.render();
         if (! html.link().isEmpty())
            link = html.link();
         if (! html.anchorText().isEmpty())
            anchorText = html.anchorText();
      }
   }

   /**
    * Returns the format of this bean property
    *
    * @return The value of the {@link Html#format()} annotation.
    */
   protected HtmlFormat getFormat() {
      return format;
   }

   /**
    * Returns <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#XML}.
    *
    * @return <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#XML}.
    */
   protected boolean isXml() {
      return format == HtmlFormat.XML;
   }

   /**
    * Returns <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#PLAIN_TEXT}.
    *
    * @return <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#PLAIN_TEXT}.
    */
   protected boolean isPlainText() {
      return format == HtmlFormat.PLAIN_TEXT;
   }

   /**
    * Returns <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#HTML}.
    *
    * @return <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#HTML}.
    */
   protected boolean isHtml() {
      return format == HtmlFormat.HTML;
   }

   /**
    * Returns <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#HTML_CDC}.
    *
    * @return <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#HTML_CDC}.
    */
   protected boolean isHtmlCdc() {
      return format == HtmlFormat.HTML_CDC;
   }

   /**
    * Returns <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#HTML_SDC}.
    *
    * @return <jk>true</jk> if {@link #getFormat()} returns {@link HtmlFormat#HTML_SDC}.
    */
   protected boolean isHtmlSdc() {
      return format == HtmlFormat.HTML_SDC;
   }

   /**
    * Returns whether this bean property should not be serialized as an HTML table.
    *
    * @return
    *    <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#noTables() @Html(noTables)} is
    *    <jk>true</jk>.
    */
   protected boolean isNoTables() {
      return noTables;
   }

   /**
    * Returns whether this bean property should not include table headers when serialized as an HTML table.
    *
    * @return
    *    <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#noTableHeaders() @Html(noTableHeaders)} is
    *    <jk>true</jk>.
    */
   public boolean isNoTableHeaders() {
      return noTableHeaders;
   }

   /**
    * Returns the render class for rendering the style and contents of this property value in HTML.
    *
    * <p>
    * This value is specified via the {@link Html#render() @Html(render)} annotation.
    *
    * @return The render class, never <jk>null</jk>.
    */
   public HtmlRender getRender() {
      return render;
   }

   /**
    * Adds a hyperlink to this value in HTML.
    *
    * <p>
    * This value is specified via the {@link Html#link() @Html(link)} annotation.
    *
    * @return The link string, or <jk>null</jk> if not specified.
    */
   public String getLink() {
      return link;
   }

   /**
    * Specifies the anchor text for this property.
    *
    * <p>
    * This value is specified via the {@link Html#anchorText() @Html(anchorText)} annotation.
    *
    * @return The link string, or <jk>null</jk> if not specified.
    */
   public String getAnchorText() {
      return anchorText;
   }
}