// ***************************************************************************************************************************
// * 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.jena;

import java.util.*;
import java.util.concurrent.*;

import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.collections.*;
import org.apache.juneau.parser.*;
import org.apache.juneau.xml.*;

/**
 * Parses RDF into POJOs.
 *
 * <h5 class='topic'>Behavior-specific subclasses</h5>
 *
 * The following direct subclasses are provided for language-specific parsers:
 * <ul class='spaced-list'>
 *    <li>
 *       {@link RdfXmlParser} - RDF/XML and RDF/XML-ABBREV.
 *    <li>
 *       {@link NTripleParser} - N-TRIPLE.
 *    <li>
 *       {@link TurtleParser} - TURTLE.
 *    <li>
 *       {@link N3Parser} - N3.
 * </ul>
 *
 * <ul class='seealso'>
 *    <li class='link'>{@doc juneau-marshall-rdf}
 * </ul>
 */
@ConfigurableContext(prefixes={RdfCommon.PREFIX,RdfParser.PREFIX})
public class RdfParser extends ReaderParser implements RdfCommon, RdfMetaProvider {

   private static final Namespace
      DEFAULT_JUNEAU_NS = Namespace.create("j", "http://www.apache.org/juneau/"),
      DEFAULT_JUNEAUBP_NS = Namespace.create("jp", "http://www.apache.org/juneaubp/");

   //-------------------------------------------------------------------------------------------------------------------
   // Configurable properties
   //-------------------------------------------------------------------------------------------------------------------

   static final String PREFIX = "RdfParser";

   /**
    * Configuration property:  Trim whitespace from text elements.
    *
    * <h5 class='section'>Property:</h5>
    * <ul class='spaced-list'>
    *    <li><b>ID:</b>  {@link org.apache.juneau.jena.RdfParser#RDF_trimWhitespace RDF_trimWhitespace}
    *    <li><b>Name:</b>  <js>"RdfParser.trimWhitespace.b"</js>
    *    <li><b>Data type:</b>  <jk>boolean</jk>
    *    <li><b>System property:</b>  <c>RdfParser.trimWhitespace</c>
    *    <li><b>Environment variable:</b>  <c>RDFPARSER_TRIMWHITESPACE</c>
    *    <li><b>Default:</b>  <jk>false</jk>
    *    <li><b>Session property:</b>  <jk>false</jk>
    *    <li><b>Annotations:</b>
    *       <ul>
    *          <li class='ja'>{@link org.apache.juneau.jena.annotation.RdfConfig#trimWhitespace()}
    *       </ul>
    *    <li><b>Methods:</b>
    *       <ul>
    *          <li class='jm'>{@link org.apache.juneau.jena.RdfParserBuilder#trimWhitespace(boolean)}
    *          <li class='jm'>{@link org.apache.juneau.jena.RdfParserBuilder#trimWhitespace()}
    *       </ul>
    * </ul>
    *
    * <h5 class='section'>Description:</h5>
    * <p>
    * If <jk>true</jk>, whitespace in text elements will be automatically trimmed.
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bcode w800'>
    *    <jc>// Create an RDF parser that trims whitespace.</jc>
    *    ReaderParser p = RdfParser
    *       .<jsm>create</jsm>()
    *       .xml()
    *       .trimWhitespace()
    *       .build();
    *
    *    <jc>// Same, but use property.</jc>
    *    ReaderParser p = RdfParser
    *       .<jsm>create</jsm>()
    *       .xml()
    *       .set(<jsf>RDF_trimWhitespace</jsf>, <jk>true</jk>)
    *       .build();
    * </p>
    */
   public static final String RDF_trimWhitespace = PREFIX + ".trimWhitespace.b";

   //-------------------------------------------------------------------------------------------------------------------
   // Instance
   //-------------------------------------------------------------------------------------------------------------------

   private final boolean trimWhitespace, looseCollections;
   private final String rdfLanguage;
   private final Namespace juneauNs, juneauBpNs;
   private final RdfCollectionFormat collectionFormat;

   final Map<String,Object> jenaProperties;

   private final Map<ClassMeta<?>,RdfClassMeta> rdfClassMetas = new ConcurrentHashMap<>();
   private final Map<BeanMeta<?>,RdfBeanMeta> rdfBeanMetas = new ConcurrentHashMap<>();
   private final Map<BeanPropertyMeta,RdfBeanPropertyMeta> rdfBeanPropertyMetas = new ConcurrentHashMap<>();

   private final Map<ClassMeta<?>,XmlClassMeta> xmlClassMetas = new ConcurrentHashMap<>();
   private final Map<BeanMeta<?>,XmlBeanMeta> xmlBeanMetas = new ConcurrentHashMap<>();
   private final Map<BeanPropertyMeta,XmlBeanPropertyMeta> xmlBeanPropertyMetas = new ConcurrentHashMap<>();

   /**
    * Constructor.
    *
    * @param ps The property store containing all the settings for this object.
    * @param consumes The list of media types that this parser consumes (e.g. <js>"application/json"</js>).
    */
   public RdfParser(PropertyStore ps, String...consumes) {
      super(ps, consumes);
      trimWhitespace = getBooleanProperty(RDF_trimWhitespace, false);
      looseCollections = getBooleanProperty(RDF_looseCollections, false);
      rdfLanguage = getStringProperty(RDF_language, "RDF/XML-ABBREV");
      juneauNs = getInstanceProperty(RDF_juneauNs, Namespace.class, DEFAULT_JUNEAU_NS);
      juneauBpNs = getInstanceProperty(RDF_juneauBpNs, Namespace.class, DEFAULT_JUNEAUBP_NS);
      collectionFormat = getProperty(RDF_collectionFormat, RdfCollectionFormat.class, RdfCollectionFormat.DEFAULT);

      ASortedMap<String,Object> m = ASortedMap.of();
      for (String k : getPropertyKeys("RdfCommon"))
         if (k.startsWith("jena."))
            m.put(k.substring(5), getProperty("RdfCommon." + k));
      jenaProperties = m.unmodifiable();
   }

   /**
    * Constructor.
    *
    * @param ps The property store containing all the settings for this object.
    */
   public RdfParser(PropertyStore ps) {
      this(ps, getConsumes(ps));
   }

   private static String getConsumes(PropertyStore ps) {
      String rdfLanguage = ps.getProperty(RDF_language, String.class, "RDF/XML-ABBREV");
      switch(rdfLanguage) {
         case "RDF/XML":
         case "RDF/XML-ABBREV": return "text/xml+rdf";
         case "N-TRIPLE": return "text/n-triple";
         case "N3": return "text/n3";
         case "N3-PP": return "text/n3-pp";
         case "N3-PLAIN": return "text/n3-plain";
         case "N3-TRIPLES": return "text/n3-triples";
         case "TURTLE": return "text/turtle";
         default: return "text/xml+rdf";
      }
   }

   @Override /* Context */
   public RdfParserBuilder builder() {
      return new RdfParserBuilder(getPropertyStore());
   }

   /**
    * Instantiates a new clean-slate {@link RdfParserBuilder} object.
    *
    * <p>
    * This is equivalent to simply calling <code><jk>new</jk> RdfParserBuilder()</code>.
    *
    * <p>
    * Note that this method creates a builder initialized to all default settings, whereas {@link #builder()} copies
    * the settings of the object called on.
    *
    * @return A new {@link RdfParserBuilder} object.
    */
   public static RdfParserBuilder create() {
      return new RdfParserBuilder();
   }

   @Override /* Parser */
   public RdfParserSession createSession() {
      return createSession(createDefaultSessionArgs());
   }

   @Override /* Parser */
   public RdfParserSession createSession(ParserSessionArgs args) {
      return new RdfParserSession(this, args);
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Extended metadata
   //-----------------------------------------------------------------------------------------------------------------

   @Override /* RdfMetaProvider */
   public RdfClassMeta getRdfClassMeta(ClassMeta<?> cm) {
      RdfClassMeta m = rdfClassMetas.get(cm);
      if (m == null) {
         m = new RdfClassMeta(cm, this);
         rdfClassMetas.put(cm, m);
      }
      return m;
   }

   @Override /* RdfMetaProvider */
   public RdfBeanMeta getRdfBeanMeta(BeanMeta<?> bm) {
      RdfBeanMeta m = rdfBeanMetas.get(bm);
      if (m == null) {
         m = new RdfBeanMeta(bm, this);
         rdfBeanMetas.put(bm, m);
      }
      return m;
   }

   @Override /* RdfMetaProvider */
   public RdfBeanPropertyMeta getRdfBeanPropertyMeta(BeanPropertyMeta bpm) {
      RdfBeanPropertyMeta m = rdfBeanPropertyMetas.get(bpm);
      if (m == null) {
         m = new RdfBeanPropertyMeta(bpm.getDelegateFor(), this);
         rdfBeanPropertyMetas.put(bpm, m);
      }
      return m;
   }

   @Override /* XmlMetaProvider */
   public XmlClassMeta getXmlClassMeta(ClassMeta<?> cm) {
      XmlClassMeta m = xmlClassMetas.get(cm);
      if (m == null) {
         m = new XmlClassMeta(cm, this);
         xmlClassMetas.put(cm, m);
      }
      return m;
   }

   @Override /* XmlMetaProvider */
   public XmlBeanMeta getXmlBeanMeta(BeanMeta<?> bm) {
      XmlBeanMeta m = xmlBeanMetas.get(bm);
      if (m == null) {
         m = new XmlBeanMeta(bm, this);
         xmlBeanMetas.put(bm, m);
      }
      return m;
   }

   @Override /* XmlMetaProvider */
   public XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm) {
      XmlBeanPropertyMeta m = xmlBeanPropertyMetas.get(bpm);
      if (m == null) {
         m = new XmlBeanPropertyMeta(bpm.getDelegateFor(), this);
         xmlBeanPropertyMetas.put(bpm, m);
      }
      return m;
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Common properties
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * RDF format for representing collections and arrays.
    *
    * @see #RDF_collectionFormat
    * @return
    *    RDF format for representing collections and arrays.
    */
   protected final RdfCollectionFormat getCollectionFormat() {
      return collectionFormat;
   }

   /**
    * Default XML namespace for bean properties.
    *
    * @see #RDF_juneauBpNs
    * @return
    *    Default XML namespace for bean properties.
    */
   protected final Namespace getJuneauBpNs() {
      return juneauBpNs;
   }

   /**
    * XML namespace for Juneau properties.
    *
    * @see #RDF_juneauNs
    * @return
    *    XML namespace for Juneau properties.
    */
   protected final Namespace getJuneauNs() {
      return juneauNs;
   }

   /**
    * RDF language.
    *
    * @see #RDF_language
    * @return
    *    The RDF language to use.
    */
   protected final String getLanguage() {
      return rdfLanguage;
   }

   /**
    * Collections should be serialized and parsed as loose collections.
    *
    * @see #RDF_looseCollections
    * @return
    *    <jk>true</jk> if collections of resources are handled as loose collections of resources in RDF instead of
    *    resources that are children of an RDF collection (e.g. Sequence, Bag).
    */
   protected final boolean isLooseCollections() {
      return looseCollections;
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Jena properties
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * All Jena-related configuration properties.
    *
    * @return
    *    A map of all Jena-related configuration properties.
    */
   protected final Map<String,Object> getJenaProperties() {
      return jenaProperties;
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Properties
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * Trim whitespace from text elements.
    *
    * @see #RDF_trimWhitespace
    * @return
    *    <jk>true</jk> if whitespace in text elements will be automatically trimmed.
    */
   protected final boolean isTrimWhitespace() {
      return trimWhitespace;
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Other methods
   //-----------------------------------------------------------------------------------------------------------------

   @Override /* Context */
   public OMap toMap() {
      return super.toMap()
         .a("RdfParser", new DefaultFilteringOMap()
            .a("trimWhitespace", trimWhitespace)
            .a("looseCollections", looseCollections)
            .a("rdfLanguage", rdfLanguage)
            .a("juneauNs", juneauNs)
            .a("juneauBpNs", juneauBpNs)
            .a("collectionFormat", collectionFormat)
         );
   }
}