001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall.jena;
018
019/**
020 * Subclass of {@link RdfParser} for parsing JSON-LD into POJOs.
021 *
022 * <p>
023 * Accepts RDF in W3C JSON-LD format and converts it to Java beans, maps, collections, and primitive
024 * types. Date/time literals are parsed via ISO 8601.
025 *
026 * <h5 class='figure'>Examples:</h5>
027 * <p class='bjava'>
028 *    <jc>// Parse JSON-LD string into a bean.</jc>
029 *    String <jv>jsonLd</jv> = ...;  <jc>// JSON-LD content</jc>
030 *    Person <jv>person</jv> = JsonLdParser.<jsf>DEFAULT</jsf>.read(<jv>jsonLd</jv>, Person.<jk>class</jk>);
031 * </p>
032 * <p class='bjava'>
033 *    <jc>// Or use the JsonLd marshaller for convenience.</jc>
034 *    Person <jv>person</jv> = JsonLd.<jsf>DEFAULT</jsf>.read(<jv>jsonLd</jv>, Person.<jk>class</jk>);
035 * </p>
036 * <p class='bjava'>
037 *    <jc>// Parse into a list of beans.</jc>
038 *    List&lt;Person&gt; <jv>people</jv> = JsonLdParser.<jsf>DEFAULT</jsf>.read(<jv>jsonLd</jv>, List.<jk>class</jk>, Person.<jk>class</jk>);
039 * </p>
040 * <p class='bjava'>
041 *    <jc>// Custom parser with swaps.</jc>
042 *    JsonLdParser <jv>p</jv> = JsonLdParser.create().swaps(DateSwap.<jk>class</jk>).build();
043 *    MyBean <jv>bean</jv> = <jv>p</jv>.read(<jv>jsonLd</jv>, MyBean.<jk>class</jk>);
044 * </p>
045 *
046 * <h5 class='figure'>Example input (bean with name/age):</h5>
047 * <p class='bjson'>
048 *    { <js>"@context"</js>: {...}, <js>"@id"</js>: <js>"..."</js>,
049 *       <js>"@type"</js>: <js>"Person"</js>, <js>"name"</js>: <js>"Alice"</js>, <js>"age"</js>: 30 }
050 * </p>
051 *
052 * <h5 class='figure'>Complex (nested address + array):</h5>
053 * <p class='bjson'>
054 *    { <js>"@context"</js>: {...}, <js>"@id"</js>: <js>"..."</js>, <js>"@type"</js>: <js>"Person"</js>,
055 *       <js>"name"</js>: <js>"Alice"</js>, <js>"age"</js>: 30,
056 *       <js>"address"</js>: { <js>"@id"</js>: <js>".../address"</js>, <js>"street"</js>: <js>"123 Main St"</js>,
057 *          <js>"city"</js>: <js>"Boston"</js>, <js>"state"</js>: <js>"MA"</js> },
058 *       <js>"tags"</js>: [<js>"a"</js>,<js>"b"</js>,<js>"c"</js>] }
059 * </p>
060 *
061 * <h5 class='section'>Notes:</h5><ul>
062 *    <li class='note'>This class is thread safe and reusable.
063 * </ul>
064 *
065 * <h5 class='section'>See Also:</h5><ul>
066 *    <li class='link'>{doc jmr.RdfDetails}
067 * </ul>
068 */
069@SuppressWarnings({
070   "java:S110" // Deep inheritance inherent to the RDF parser hierarchy.
071})
072public class JsonLdParser extends RdfParser {
073
074   /** Default JSON-LD parser, all default settings.*/
075   public static final JsonLdParser DEFAULT = new JsonLdParser(create());
076
077   /**
078    * Creates a new builder for this object.
079    *
080    * @return A new builder.
081    */
082   @SuppressWarnings({
083      "java:S1452", // Builder<?> wildcard return intentional; callers chain via fluent API without needing the concrete type
084      "java:S9149" // Public Juneau DSL factory; hiding parent create() is intentional.
085   })
086   public static RdfParser.Builder<?> create() {
087      return RdfParser.create().jsonLd();
088   }
089
090   /**
091    * Constructor.
092    *
093    * @param builder The builder for this object.
094    *    <br>Cannot be <jk>null</jk>.
095    */
096   public JsonLdParser(RdfParser.Builder<?> builder) {
097      super(builder.jsonLd().consumes("application/ld+json"));
098   }
099}