All Downloads are FREE. Search and download functionalities are using the official Maven repository.

tech.simter.condition.Condition Maven / Gradle / Ivy

Go to download

Simter Core

There is a newer version: 1.1.0
Show newest version
package tech.simter.condition;

import javax.json.Json;
import javax.json.JsonArray;
import javax.json.JsonString;
import javax.json.JsonValue;
import java.io.StringReader;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.text.MessageFormat;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

import static tech.simter.condition.ComparisonOperator.*;
import static tech.simter.condition.ValueConverter.convert;

/**
 * The common condition interface.
 * 

 * Only expose the condition's markup. Use to hide actual sql to avoid sql attack.
 *
 * @author RJ
 */
public interface Condition {
  /**
   * The identity markup.
   *
   * @return The id
   */
  String getId();

  /**
   * The comparison operator.
   *
   * @return The operator
   */
  ComparisonOperator getOperator();

  /**
   * The value
   *
   * @return The value
   */
  Object getValue();

  /**
   * The values.
   * 

   * This method only support for multiple value condition. At this situation,
   * this method only force convert the {@link #getValue()} to {@link List List<Object>} and return it.
   *
   * @return The values
   */
  List getValues();

  /**
   * Convert to query language.
   * 

   * Such as key="code", name=":code", this={@link ComparisonOperator#Equals},
   * then the return value should be "code = :code".
   *
   * @param alias               The alias for sql, use {@link #getId()} instead if ignore
   * @param paramValueContainer The NamedParam values container
   * @param namedParamNames     The NamedParam name, use '?' instead if not specified
   * @return query language
   * @throws UnsupportedOperationException If is range enum
   */
  /**
   * Convert the condition to a query language with the specific NamedParam names.
   * 

   * If NamedParam is not specified and the condition has a valid value in the value position,
   * use {@link #getId()} as the default NamedParam name.
   * 

   * For examples: 

   * 1) id="code", operator={@link ComparisonOperator#Equals Equals}, namedParamNames=["code1"].
   * Then return value should be "code = :code1".

   * 2) id="code", operator={@link ComparisonOperator#RangeGTAndLTE (]}, namedParamNames=["code1", "code2"].
   * Then return value should be "code > :code1 and code <= :code2".
   *
   * @param alias               The alias for query language, use {@link #getId()} instead if ignore
   * @param paramValueContainer The NamedParam values container
   * @param namedParamNames     The NamedParam names
   * @return The query language
   */
  String toQL(String alias, Map paramValueContainer, String... namedParamNames);

  /**
   * Convert the condition to a position query language.
   * 

   * If NamedParam is not specified and the condition has a valid value in the value position,
   * use {@link #getId()} as the default NamedParam name.
   * 

   * For examples: 

   * 1) id="code", operator={@link ComparisonOperator#Equals Equals}, alias=null.
   * Then return value should be "code = ?".

   * 2) id="code", operator={@link ComparisonOperator#Equals Equals}, alias="t_code".
   * Then return value should be "t_code = ?".

   * 3) id="code", operator={@link ComparisonOperator#RangeGTAndLTE (]}, alias=null.
   * Then return value should be "code > ? and code <= ?".
   *
   * @param alias               The alias for query language, use {@link #getId()} instead if ignore
   * @param paramValueContainer The position values container
   * @return The position query language
   */
  String toQL(String alias, List paramValueContainer);

  /**
   * The shortcut for `toQL((String) null, (List<Object>) null)`
   *
   * @return The position query language
   */
  String toQL();

  /**
   * Build a new Condition instance.
   *
   * @param id       the id
   * @param operator the comparison operator
   * @param value    the value
   * @return the Condition instance
   */
  static Condition of(String id, ComparisonOperator operator, Object value) {
    return new Impl(id, operator, value);
  }

  /**
   * Build a new Condition instance.
   *
   * @param id       the id
   * @param operator the comparison operator
   * @return the Condition instance
   */
  static Condition of(String id, ComparisonOperator operator) {
    return new Impl(id, operator, null);
  }

  /**
   * Convert search value to Condition list.
   * 

   * The search param value must has standard JsonArray structure.
   * Each array item holds the condition data.
   * It must also be a standard JsonArray structure with [id, value[, type, operator]].
   * The type and operator is optional.
   * When ignore, the default type is {@link String}, the default operator is {@link ComparisonOperator#Equals}.
   *
   * @param search The search value
   * @return The Condition instance list
   */
  static List toConditions(String search) {
    if (search == null || search.isEmpty()) return null;
    try {
      List list = new ArrayList<>();
      Json.createReader(new StringReader(URLDecoder.decode(search, "UTF-8")))
        .readArray()
        .forEach(item -> list.add(toCondition((JsonArray) item)));
      return list;
    } catch (UnsupportedEncodingException e) {
      throw new RuntimeException(e);
    }
  }

  /**
   * Build a new Condition instance.
   * 

   * The item parameter must has the specific structure with [id, value[, type, operator]].
   * The type and operator is optional.
   *
   * @param item The JsonArray item hold the structure data
   * @return the Condition instance
   */
  static Condition toCondition(JsonArray item) {
    // verify JsonArray structure: [id, value[, type, operator]]
    if (item == null || item.size() < 2)
      throw new IllegalArgumentException("invalid array structure, at lease has two item in the array: jsonArray=" + item);

    // The id
    String id = item.getString(0);

    // The value
    Object value;
    String type = item.size() > 2 && item.get(2).getValueType() != JsonValue.ValueType.NULL ?
      item.getString(2) : "String"; // Default type is String
    JsonValue ItemValue = item.get(1);
    if (ItemValue.getValueType() == JsonValue.ValueType.STRING) {        // Single value
      value = convert(type, item.getString(1));
    } else if (ItemValue.getValueType() == JsonValue.ValueType.ARRAY) {  // Multiple value
      JsonArray array = item.getJsonArray(1);
      List values = new ArrayList<>();
      array.forEach(v ->
        values.add(v.getValueType() == JsonValue.ValueType.NULL ? null : convert(type, ((JsonString) v).getString())));
      value = values;
    } else throw new IllegalArgumentException(
      "unsupported value type: valueType=" + item.getValueType() + ", jsonArray=" + item
    );

    // The operator
    ComparisonOperator operator = item.size() > 3 ?
      ComparisonOperator.symbolOf(item.getString(3)) : ComparisonOperator.Equals; // Default operator is Equals

    return new Impl(id, operator, value);
  }

  /**
   * Convert the condition to a query language with the specific NamedParam names.
   * 

   * If NamedParam is not specified and the condition has a valid value in the value position,
   * use {@link #getId()} as the default NamedParam name.
   * 

   * For examples: 

   * 1) id="code", operator={@link ComparisonOperator#Equals Equals}, namedParamNames=["code1"].
   * Then return value should be "code = :code1".

   * 2) id="code", operator={@link ComparisonOperator#RangeGTAndLTE (]}, namedParamNames=["code1", "code2"].
   * Then return value should be "code > :code1 and code <= :code2".
   *
   * @param condition           The condition
   * @param alias               The alias for query language, use {@link #getId()} instead if ignore
   * @param paramValueContainer The NamedParam values container
   * @param namedParamNames     The NamedParam names
   * @return The query language
   */
  static String toQL(Condition condition, String alias, Map paramValueContainer, String... namedParamNames) {
    if (condition == null) throw new IllegalArgumentException("The condition should not be null.");
    if (condition.getId() == null || condition.getId().isEmpty())
      throw new IllegalArgumentException("The condition's id should not be null or empty.");
    if (condition.getOperator() == null)
      throw new IllegalArgumentException("The condition's operator should not be null.");
    if (alias == null || alias.isEmpty()) alias = condition.getId();

    int len = namedParamNames == null ? 0 : namedParamNames.length;
    if (condition.getOperator().isRange()) {
      List values = condition.getValues();
      String startName = len > 0 ? namedParamNames[0] :
        (values.get(0) == null ? null : condition.getId() + "0");
      String endName = len > 1 ? namedParamNames[1] :
        (values.size() < 2 || values.get(1) == null ? null : condition.getId() + "1");
      if ((startName == null || startName.isEmpty()) && (endName == null || endName.isEmpty()))
        throw new IllegalArgumentException(MessageFormat.format(
          "At lease supply one NamedParam: id={0}, operator={1}, values={2}, namedParamNames={3)",
          condition.getId(), condition.getOperator(), condition.getValue(), namedParamNames));

      StringBuffer q = new StringBuffer();
      if (startName != null && !startName.isEmpty()) {
        q.append(alias)
          .append(" ")
          .append(condition.getOperator().symbol().startsWith("[") ? ">=" : ">")
          .append(" ")
          .append(":" + startName);
        paramValueContainer.put(startName, values.get(0));
      }
      if (endName != null && !endName.isEmpty()) {
        if (q.length() > 0) q.append(" and ");
        q.append(alias)
          .append(" ")
          .append(condition.getOperator().symbol().endsWith("]") ? "<=" : "<")
          .append(" ")
          .append(":" + endName);
        paramValueContainer.put(endName, values.get(1));
      }
      return q.toString();
    } else {
      if (condition.getOperator() == IsNull || condition.getOperator() == IsNotNull) {
        return alias + " " + condition.getOperator().symbol();
      } else if (condition.getOperator() == In || condition.getOperator() == NotIn) {
        String ql = alias + " " + condition.getOperator().symbol() + " (";
        if (len == 0) {                  // use ':[id]N for each value in list values. e.g. ':name1, name2, ...'
          if (condition.getValues().size() == 1) {
            ql += ":" + condition.getId();
            paramValueContainer.put(condition.getId(), condition.getValues().get(0));
          } else {
            ql += IntStream.range(0, condition.getValues().size())
              .mapToObj(i -> {
                String name = condition.getId() + i;
                paramValueContainer.put(name, condition.getValues().get(i));
                return ":" + name;
              }).collect(Collectors.joining(", "));
          }
        } else if (len == 1) {           // such as jpa array param - "id in (:ids)"
          ql += ":" + namedParamNames[0];
          paramValueContainer.put(namedParamNames[0], condition.getValue());
        } else {                         // use NamedParam names
          ql += Arrays.stream(namedParamNames).map(n -> ":" + n).collect(Collectors.joining(", "));
          for (int i = 0; i < condition.getValues().size(); i++)
            paramValueContainer.put(namedParamNames[i], condition.getValues().get(i));
        }
        ql += ")";
        return ql;
      } else {
        Object value = condition.getValue();
        if (condition.getOperator().isLike()) value = addPercentSymbolToValueForLike(condition.getOperator(), value);
        String name = len > 0 ? namedParamNames[0] : condition.getId();
        paramValueContainer.put(name, value);
        return alias + " " + condition.getOperator().symbol() + " :" + name;
      }
    }
  }

  /**
   * Convert the condition to a position query language.
   * 

   * If NamedParam is not specified and the condition has a valid value in the value position,
   * use {@link #getId()} as the default NamedParam name.
   * 

   * For examples: 

   * 1) id="code", operator={@link ComparisonOperator#Equals Equals}, alias=null.
   * Then return value should be "code = ?".

   * 2) id="code", operator={@link ComparisonOperator#Equals Equals}, alias="t_code".
   * Then return value should be "t_code = ?".

   * 3) id="code", operator={@link ComparisonOperator#RangeGTAndLTE (]}, alias=null.
   * Then return value should be "code > ? and code <= ?".
   *
   * @param condition           The condition
   * @param alias               The alias for query language, use {@link #getId()} instead if ignore
   * @param paramValueContainer The position values container
   * @return The query language
   */
  static String toQL(Condition condition, String alias, List paramValueContainer) {
    boolean hasContainer = paramValueContainer != null;
    if (condition == null) throw new IllegalArgumentException("The condition should not be null.");
    if (condition.getId() == null || condition.getId().isEmpty())
      throw new IllegalArgumentException("The condition's id should not be null or empty.");
    if (condition.getOperator() == null)
      throw new IllegalArgumentException("The condition's operator should not be null.");
    if (alias == null || alias.isEmpty()) alias = condition.getId();

    if (condition.getOperator().isRange()) {
      int len = condition.getValues().size();
      if (len == 0) throw new IllegalArgumentException(MessageFormat.format(
        "At lease supply one ParamValue: id={0}, operator={1}, values={2}",
        condition.getId(), condition.getOperator(), condition.getValue()));
      StringBuffer q = new StringBuffer();
      if (condition.getValues().get(0) != null) {
        q.append(alias)
          .append(" ")
          .append(condition.getOperator().symbol().startsWith("[") ? ">=" : ">")
          .append(" ")
          .append("?");
        if (hasContainer) paramValueContainer.add(condition.getValue());
      }
      if (len > 1) {
        if (q.length() > 0) q.append(" and ");
        q.append(alias)
          .append(" ")
          .append(condition.getOperator().symbol().endsWith("]") ? "<=" : "<")
          .append(" ")
          .append("?");
        if (hasContainer) paramValueContainer.add(condition.getValue());
      }
      return q.toString();
    } else {
      if (condition.getOperator() == IsNull || condition.getOperator() == IsNotNull) {
        return alias + " " + condition.getOperator().symbol();
      } else if (condition.getOperator() == In || condition.getOperator() == NotIn) {
        String ql = alias + " " + condition.getOperator().symbol() + " (";
        ql += condition.getValues().stream().filter(Objects::nonNull).map(value -> {
          if (hasContainer) paramValueContainer.add(value);
          return "?";
        }).collect(Collectors.joining(", "));
        ql += ")";
        return ql;
      } else {
        Object value = condition.getValue();
        value = addPercentSymbolToValueForLike(condition.getOperator(), value);
        if (hasContainer) paramValueContainer.add(value);
        return alias + " " + condition.getOperator().symbol() + " ?";
      }
    }
  }

  /**
   * The inner Condition implement.
   */
  class Impl implements Condition {
    protected String id;
    protected ComparisonOperator operator;
    protected Object value;

    Impl(String id, ComparisonOperator operator, Object value) {
      this.id = id;
      this.operator = operator;
      this.value = value;
    }

    @Override
    public String getId() {
      return this.id;
    }

    @Override
    public ComparisonOperator getOperator() {
      return this.operator;
    }

    @Override
    public Object getValue() {
      return this.value;
    }

    @Override
    @SuppressWarnings("unchecked")
    public List getValues() {
      return (List) getValue();
    }

    @Override
    public String toQL(String alias, Map paramValueContainer, String... namedParamNames) {
      return Condition.toQL(this, alias, paramValueContainer, namedParamNames);
    }

    @Override
    public String toQL(String alias, List paramValueContainer) {
      return Condition.toQL(this, alias, paramValueContainer);
    }

    @Override
    public String toQL() {
      return Condition.toQL(this, null, null);
    }

    @Override
    public String toString() {
      return this.toQL(null, null);
    }
  }
}    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy