// ***************************************************************************************************************************
// * 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 static org.apache.juneau.jena.RdfCommon.*;
import static org.apache.juneau.jena.RdfParser.*;

import java.util.*;

import org.apache.juneau.*;
import org.apache.juneau.http.*;
import org.apache.juneau.jena.annotation.*;
import org.apache.juneau.parser.*;
import org.apache.juneau.xml.*;
import org.apache.juneau.xml.annotation.*;

/**
 * Builder class for building instances of RDF parsers.
 */
public class RdfParserBuilder extends ReaderParserBuilder {

   /**
    * Constructor, default settings.
    */
   public RdfParserBuilder() {
      super();
   }

   /**
    * Constructor.
    *
    * @param ps The initial configuration settings for this builder.
    */
   public RdfParserBuilder(PropertyStore ps) {
      super(ps);
   }

   @Override /* ContextBuilder */
   public RdfParser build() {
      return build(RdfParser.class);
   }


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

   /**
    * Configuration property:  RDF format for representing collections and arrays.
    *
    * <p>
    * Possible values:
    * <ul class='spaced-list'>
    *    <li>
    *       <js>"DEFAULT"</js> - Default format.  The default is an RDF Sequence container.
    *    <li>
    *       <js>"SEQ"</js> - RDF Sequence container.
    *    <li>
    *       <js>"BAG"</js> - RDF Bag container.
    *    <li>
    *       <js>"LIST"</js> - RDF List container.
    *    <li>
    *       <js>"MULTI_VALUED"</js> - Multi-valued properties.
    * </ul>
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_collectionFormat}
    * </ul>
    *
    * @param value The new value for this property.
    * @return This object (for method chaining).
    */
   public RdfParserBuilder collectionFormat(RdfCollectionFormat value) {
      return set(RDF_collectionFormat, value);
   }

   /**
    * Configuration property:  Default XML namespace for bean properties.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_juneauBpNs}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <code>{j:<js>'http://www.apache.org/juneaubp/'</js>}</code>.
    * @return This object (for method chaining).
    */
   public RdfParserBuilder juneauBpNs(Namespace value) {
      return set(RDF_juneauBpNs, value);
   }

   /**
    * Configuration property:  XML namespace for Juneau properties.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_juneauNs}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <code>{j:<js>'http://www.apache.org/juneau/'</js>}</code>.
    * @return This object (for method chaining).
    */
   public RdfParserBuilder juneauNs(Namespace value) {
      return set(RDF_juneauNs, value);
   }

   /**
    * Configuration property:  RDF language.
    *
    * <p>
    * Can be any of the following:
    * <ul class='spaced-list'>
    *    <li>
    *       <js>"RDF/XML"</js>
    *    <li>
    *       <js>"RDF/XML-ABBREV"</js> (default)
    *    <li>
    *       <js>"N-TRIPLE"</js>
    *    <li>
    *       <js>"N3"</js> - General name for the N3 writer.
    *       Will make a decision on exactly which writer to use (pretty writer, plain writer or simple writer) when
    *       created.
    *       Default is the pretty writer but can be overridden with system property
    *       <code>com.hp.hpl.jena.n3.N3JenaWriter.writer</code>.
    *    <li>
    *       <js>"N3-PP"</js> - Name of the N3 pretty writer.
    *       The pretty writer uses a frame-like layout, with prefixing, clustering like properties and embedding
    *       one-referenced bNodes.
    *    <li>
    *       <js>"N3-PLAIN"</js> - Name of the N3 plain writer.
    *       The plain writer writes records by subject.
    *    <li>
    *       <js>"N3-TRIPLES"</js> - Name of the N3 triples writer.
    *       This writer writes one line per statement, like N-Triples, but does N3-style prefixing.
    *    <li>
    *       <js>"TURTLE"</js> -  Turtle writer.
    *       http://www.dajobe.org/2004/01/turtle/
    * </ul>
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_language}
    * </ul>
    *
    * @param value The new value for this property.
    * @return This object (for method chaining).
    */
   public RdfParserBuilder language(String value) {
      return set(RDF_language, value);
   }

   /**
    * Configuration property:  Collections should be serialized and parsed as loose collections.
    *
    * <p>
    * When specified, 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).
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_looseCollections}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public RdfParserBuilder looseCollections(boolean value) {
      return set(RDF_looseCollections, value);
   }

   /**
    * Configuration property:  Collections should be serialized and parsed as loose collections.
    *
    * <p>
    * Shortcut for calling <code>looseCollection(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_looseCollections}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public RdfParserBuilder looseCollections() {
      return set(RDF_looseCollections, true);
   }

   /**
    * Configuration property:  RDF language.
    *
    * <p>
    * Shortcut for calling <code>language(<jsf>LANG_N3</jsf>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_language}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public RdfParserBuilder n3() {
      return language(Constants.LANG_N3);
   }

   /**
    * Configuration property:  RDF language.
    *
    * <p>
    * Shortcut for calling <code>language(<jsf>LANG_NTRIPLE</jsf>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_language}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public RdfParserBuilder ntriple() {
      return language(Constants.LANG_NTRIPLE);
   }

   /**
    * Configuration property:  Trim whitespace from text elements.
    *
    * <p>
    * If <jk>true</jk>, whitespace in text elements will be automatically trimmed.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_trimWhitespace}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public RdfParserBuilder trimWhitespace(boolean value) {
      return set(RDF_trimWhitespace, value);
   }

   /**
    * Configuration property:  Trim whitespace from text elements.
    *
    * <p>
    * Shortcut for calling <code>trimWhitespace(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_trimWhitespace}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public RdfParserBuilder trimWhitespace() {
      return set(RDF_trimWhitespace, true);
   }

   /**
    * Shortcut for calling <code>language(<jsf>LANG_TURTLE</jsf>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_language}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public RdfParserBuilder turtle() {
      return language(Constants.LANG_TURTLE);
   }

   /**
    * Configuration property:  Reuse XML namespaces when RDF namespaces not specified.
    *
    * <p>
    * When specified, namespaces defined using {@link XmlNs @XmlNs} and {@link org.apache.juneau.xml.annotation.Xml @Xml} will be
    * inherited by the RDF parsers.
    * Otherwise, namespaces will be defined using {@link RdfNs @RdfNs} and {@link Rdf @Rdf}.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_useXmlNamespaces}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>true</jk>.
    * @return This object (for method chaining).
    */
   public RdfParserBuilder useXmlNamespaces(boolean value) {
      return set(RDF_useXmlNamespaces, value);
   }

   /**
    * Shortcut for calling <code>language(<jsf>LANG_RDF_XML</jsf>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_language}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public RdfParserBuilder xml() {
      return language(Constants.LANG_RDF_XML);
   }

   /**
    * Shortcut for calling <code>language(<jsf>LANG_RDF_XML_ABBREV</jsf>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link RdfParser#RDF_language}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public RdfParserBuilder xmlabbrev() {
      return language(Constants.LANG_RDF_XML_ABBREV);
   }

   @Override /* ReaderParserBuilder */
   public RdfParserBuilder fileCharset(String value) {
      super.fileCharset(value);
      return this;
   }

   @Override /* ReaderParserBuilder */
   public RdfParserBuilder inputStreamCharset(String value) {
      super.inputStreamCharset(value);
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder autoCloseStreams(boolean value) {
      super.autoCloseStreams(value);
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder autoCloseStreams() {
      super.autoCloseStreams();
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder debugOutputLines(int value) {
      super.debugOutputLines(value);
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder listener(Class<? extends ParserListener> value) {
      super.listener(value);
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder strict(boolean value) {
      super.strict(value);
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder strict() {
      super.strict();
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder trimStrings(boolean value) {
      super.trimStrings(value);
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder trimStrings() {
      super.trimStrings();
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder unbuffered(boolean value) {
      super.unbuffered(value);
      return this;
   }

   @Override /* ParserBuilder */
   public RdfParserBuilder unbuffered() {
      super.unbuffered();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanClassVisibility(Visibility value) {
      super.beanClassVisibility(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanConstructorVisibility(Visibility value) {
      super.beanConstructorVisibility(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanDictionary(boolean append, Object...values) {
      super.beanDictionary(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanDictionary(Class<?>...values) {
      super.beanDictionary(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanDictionary(Object...values) {
      super.beanDictionary(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanDictionaryRemove(Object...values) {
      super.beanDictionaryRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanFieldVisibility(Visibility value) {
      super.beanFieldVisibility(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanFilters(boolean append, Object...values) {
      super.beanFilters(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanFilters(Class<?>...values) {
      super.beanFilters(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanFilters(Object...values) {
      super.beanFilters(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanFiltersRemove(Object...values) {
      super.beanFiltersRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanMapPutReturnsOldValue(boolean value) {
      super.beanMapPutReturnsOldValue(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanMapPutReturnsOldValue() {
      super.beanMapPutReturnsOldValue();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanMethodVisibility(Visibility value) {
      super.beanMethodVisibility(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beansRequireDefaultConstructor(boolean value) {
      super.beansRequireDefaultConstructor(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beansRequireDefaultConstructor() {
      super.beansRequireDefaultConstructor();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beansRequireSerializable(boolean value) {
      super.beansRequireSerializable(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beansRequireSerializable() {
      super.beansRequireSerializable();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beansRequireSettersForGetters(boolean value) {
      super.beansRequireSettersForGetters(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beansRequireSettersForGetters() {
      super.beansRequireSettersForGetters();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beansRequireSomeProperties(boolean value) {
      super.beansRequireSomeProperties(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder beanTypePropertyName(String value) {
      super.beanTypePropertyName(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder debug() {
      super.debug();
      return this;
   }

   @Override /* BeanContextBuilder */
   public <T> RdfParserBuilder example(Class<T> c, T o) {
      super.example(c, o);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder ignoreInvocationExceptionsOnGetters(boolean value) {
      super.ignoreInvocationExceptionsOnGetters(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder ignoreInvocationExceptionsOnGetters() {
      super.ignoreInvocationExceptionsOnGetters();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder ignoreInvocationExceptionsOnSetters(boolean value) {
      super.ignoreInvocationExceptionsOnSetters(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder ignoreInvocationExceptionsOnSetters() {
      super.ignoreInvocationExceptionsOnSetters();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder ignorePropertiesWithoutSetters(boolean value) {
      super.ignorePropertiesWithoutSetters(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder ignoreUnknownBeanProperties(boolean value) {
      super.ignoreUnknownBeanProperties(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder ignoreUnknownBeanProperties() {
      super.ignoreUnknownBeanProperties();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder ignoreUnknownNullBeanProperties(boolean value) {
      super.ignoreUnknownNullBeanProperties(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public <T> RdfParserBuilder implClass(Class<T> interfaceClass, Class<? extends T> implClass) {
      super.implClass(interfaceClass, implClass);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder implClasses(Map<String,Class<?>> values) {
      super.implClasses(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder locale(Locale value) {
      super.locale(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder mediaType(MediaType value) {
      super.mediaType(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder notBeanClasses(boolean append, Object...values) {
      super.notBeanClasses(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder notBeanClasses(Class<?>...values) {
      super.notBeanClasses(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder notBeanClasses(Object...values) {
      super.notBeanClasses(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder notBeanClassesRemove(Object...values) {
      super.notBeanClassesRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder notBeanPackages(boolean append, Object...values) {
      super.notBeanPackages(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder notBeanPackages(Object...values) {
      super.notBeanPackages(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder notBeanPackages(String...values) {
      super.notBeanPackages(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder notBeanPackagesRemove(Object...values) {
      super.notBeanPackagesRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder pojoSwaps(boolean append, Object...values) {
      super.pojoSwaps(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder pojoSwaps(Class<?>...values) {
      super.pojoSwaps(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder pojoSwaps(Object...values) {
      super.pojoSwaps(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder pojoSwapsRemove(Object...values) {
      super.pojoSwapsRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder sortProperties(boolean value) {
      super.sortProperties(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder sortProperties() {
      super.sortProperties();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder timeZone(TimeZone value) {
      super.timeZone(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder useEnumNames() {
      super.useEnumNames();
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder useInterfaceProxies(boolean value) {
      super.useInterfaceProxies(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder useJavaBeanIntrospector(boolean value) {
      super.useJavaBeanIntrospector(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public RdfParserBuilder useJavaBeanIntrospector() {
      super.useJavaBeanIntrospector();
      return this;
   }

   @Override /* ContextBuilder */
   public RdfParserBuilder set(String name, Object value) {
      super.set(name, value);
      return this;
   }

   @Override /* ContextBuilder */
   public RdfParserBuilder set(boolean append, String name, Object value) {
      super.set(append, name, value);
      return this;
   }

   @Override /* ContextBuilder */
   public RdfParserBuilder set(Map<String,Object> properties) {
      super.set(properties);
      return this;
   }

   @Override /* ContextBuilder */
   public RdfParserBuilder add(Map<String,Object> properties) {
      super.add(properties);
      return this;
   }

   @Override /* ContextBuilder */
   public RdfParserBuilder addTo(String name, Object value) {
      super.addTo(name, value);
      return this;
   }

   @Override /* ContextBuilder */
   public RdfParserBuilder addTo(String name, String key, Object value) {
      super.addTo(name, key, value);
      return this;
   }

   @Override /* ContextBuilder */
   public RdfParserBuilder removeFrom(String name, Object value) {
      super.removeFrom(name, value);
      return this;
   }

   @Override /* ContextBuilder */
   public RdfParserBuilder apply(PropertyStore copyFrom) {
      super.apply(copyFrom);
      return this;
   }
}