org.rosaenlg.lib.RenderOptions 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;

/*-
 * #%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.json.JSONObject;

/**
 * RosaeNLG runtime options helper.
 * 
 * Runtime options
 * 
 * 
 * @author Ludan Stoecklé [email protected]
 */
public class RenderOptions {
  private String language;
  private Integer forceRandomSeed;
  private Boolean disableFiltering;
  private String defaultSynoMode;
  private Integer defaultAmong;

  /**
   * Create an empty object.
   * 
   */
  public RenderOptions() {
  }
    

  /**
   * Create from a JSON object by picking relevant parameters.
   * 
   * @param jsonOptions json options which can contain runtime parameters
   */
  public RenderOptions(JSONObject jsonOptions) {

    language = jsonOptions.getString("language");
    if (jsonOptions.has("forceRandomSeed")) {
      forceRandomSeed = jsonOptions.getInt("forceRandomSeed");
    }
    if (jsonOptions.has("disableFiltering")) {
      disableFiltering = jsonOptions.getBoolean("disableFiltering");
    }
    if (jsonOptions.has("defaultSynoMode")) {
      defaultSynoMode = jsonOptions.getString("defaultSynoMode");
    }
    if (jsonOptions.has("defaultAmong")) {
      defaultAmong = jsonOptions.getInt("defaultAmong");
    }
  }


  /**
   * Serializes the object to a JSON String.
   * 
   * @return String the object as a JSON String
   */
  public String toJson() {
    JSONObject res = new JSONObject();
    // must not be null
    res.put("language", this.language);

    if (this.forceRandomSeed != null) {
      res.put("forceRandomSeed", this.forceRandomSeed);
    }
    if (this.disableFiltering != null) {
      res.put("disableFiltering", this.disableFiltering);
    }
    if (this.defaultSynoMode != null) {
      res.put("defaultSynoMode", this.defaultSynoMode);
    }
    if (this.defaultAmong != null) {
      res.put("defaultAmong", this.defaultAmong);
    }
    return res.toString();
  }

  /**
   * sets the language, for instance 'en_US' or 'fr_FR'.
   * 
   * @param language the language
   * @return this to set further options
   */
  public RenderOptions setLanguage(String language) {
    this.language = language;
    return this;
  }

  /**
   * sets forceRandomSeed param, which is the random seed.
   * 
   * @param forceRandomSeed the random seed
   * @return this to set further options
   */
  public RenderOptions setForceRandomSeed(Integer forceRandomSeed) {
    this.forceRandomSeed = forceRandomSeed;
    return this;
  }

  /**
   * sets disableFiltering param, which disables filtering.
   * 
   * @param disableFiltering put true to disable (default is false: filtering is enabled)
   * @return this to set further options
   */
  public RenderOptions setDisableFiltering(Boolean disableFiltering) {
    this.disableFiltering = disableFiltering;
    return this;
  }

  /**
   * sets the default synonym mode.
   * 
   * @param defaultSynoMode the default synonym mode
   * @return this to set further options
   */
  public RenderOptions setDefaultSynoMode(String defaultSynoMode) {
    this.defaultSynoMode = defaultSynoMode;
    return this;
  }

  /**
   * sets the defaultAmong value.
   * 
   * @param defaultAmong the default among value
   * @return this to set further options
   */
  public RenderOptions setDefaultAmong(Integer defaultAmong) {
    this.defaultAmong = defaultAmong;
    return this;
  }


  /**
   * gets the language.
   * 
   * @return the language
   */
  public String getLanguage() {
    return this.language;
  }

  /**
   * gets the random seed.
   * 
   * @return this to set further options
   */
  public Integer getRandomSeed() {
    return this.forceRandomSeed;
  }

  /**
   * gets disableFiltering param.
   * 
   * @return disableFiltering param
   */
  public Boolean getDisableFiltering() {
    return this.disableFiltering;
  }

  /**
   * gets the default synonym mode.
   * 
   * @return defaultSynoMode
   */
  public String getDefaultSynoMode() {
    return this.defaultSynoMode;
  }

  /**
   * gets the defaultAmong value.
   * 
   * @return defaultAmong
   */
  public Integer getDefaultAmong() {
    return this.defaultAmong;
  }  
}