org.rosaenlg.lib.JsonPackage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-wrapper Show documentation
Java wrapper around RosaeNLG (JavaScript Natural Language Generation library), using GraalVM
There is a newer version: 3.2.2
package org.rosaenlg.lib;

import java.io.InputStream;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

/*-
 * #%L
 * RosaeNLG for Java
 * %%
 * Copyright (C) 2019 RosaeNLG.org, Ludan Stoecklé
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * #L%
 */

import org.everit.json.schema.Schema;
import org.everit.json.schema.ValidationException;
import org.everit.json.schema.loader.SchemaLoader;

import org.json.JSONObject;
import org.json.JSONTokener;

/**
 * Will contain a deserialized JSON package of a template.
 * 
 * To generate a JSON package from plain templates using gulp, see 
 * 
 * 
 * @author Ludan Stoecklé [email protected]
 */
public class JsonPackage {

  private String initialPackage;
  private String templateId;
  private String entryTemplate;
  private CompileOptions compileInfo;
  private Map templates = new HashMap();
  private Autotest autotest;

  /** Constructor using a JSON string.
   * 
   * @param jsonPackageAsString the string containing the JSON package
   * @throws ValidationException if the JSON schema is not respected
   */
  public JsonPackage(String jsonPackageAsString) throws ValidationException {

    this.initialPackage = jsonPackageAsString;

    JSONObject jsonPackage = new JSONObject(jsonPackageAsString);

    {
      InputStream inputStreamSchema = getClass().getResourceAsStream("/jsonPackage.schema.json");
      JSONObject rawSchema = new JSONObject(new JSONTokener(inputStreamSchema));
      Schema schema = SchemaLoader.load(rawSchema);
      schema.validate(jsonPackage);
    }

    this.templateId = jsonPackage.getString("templateId");
    this.entryTemplate = jsonPackage.getString("entryTemplate");
    
    JSONObject compileInfoJson = jsonPackage.getJSONObject("compileInfo");
    this.compileInfo = new CompileOptions(compileInfoJson);

    JSONObject templatesJson = jsonPackage.getJSONObject("templates");
    Iterator keys = templatesJson.keys();
    while (keys.hasNext()) {
      String key = keys.next();
      templates.put(key, templatesJson.getString(key));
    }

    if (jsonPackage.has("autotest")) {
      this.autotest = new Autotest(jsonPackage.getJSONObject("autotest"));
    }
  }

  
  /** Returns the template ID.
   * 
   * @return String template ID
   */
  public String getTemplateId() {
    return this.templateId;
  }
  
  /** Returns the entry template.
   * 
   * The entry template is the one that is indicated when compiling, and which can include other
   * templates (in the same JSON package).
   * 
   * 
   * @return String the name of the entry template
   */
  public String getEntryTemplate() {
    return this.entryTemplate;
  }
  
  /** Getter on the compile options.
   * @return CompileOptions
   */
  public CompileOptions getCompileInfo() {
    return this.compileInfo;
  }
  
  /** Getter on the template content.
   * 
   * 
   * Key value where the key is the template name, and the value the content of the template.
   * 
   * 
   * @return template name and template content map
   */
  public Map getTemplates() {
    return this.templates;
  }
  
  /** Getter on the auto test part of the package.
   * @return Autotest the auto test, if exists
   */
  public Autotest getAutotest() {
    return this.autotest;
  }
  
  /** Returns the initial value of the template, as a String.
   * @return String the initial template
   */
  public String getInitialPackage() {
    return this.initialPackage;
  }
  
}