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

com.datastax.driver.core.querybuilder.Clause Maven / Gradle / Ivy

/*
 * Copyright DataStax, Inc.
 *
 * Licensed 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 com.datastax.driver.core.querybuilder;

import com.datastax.driver.core.CodecRegistry;
import com.google.common.collect.Lists;
import java.util.List;

public abstract class Clause extends Utils.Appendeable {

  abstract String name();

  abstract Object firstValue();

  private abstract static class AbstractClause extends Clause {
    final String name;

    private AbstractClause(String name) {
      this.name = name;
    }

    @Override
    String name() {
      return name;
    }
  }

  static class SimpleClause extends AbstractClause {

    private final String op;
    private final Object value;

    SimpleClause(String name, String op, Object value) {
      super(name);
      this.op = op;
      this.value = value;
    }

    @Override
    void appendTo(StringBuilder sb, List variables, CodecRegistry codecRegistry) {
      Utils.appendName(name, sb).append(op);
      Utils.appendValue(value, codecRegistry, sb, variables);
    }

    @Override
    Object firstValue() {
      return value;
    }

    @Override
    boolean containsBindMarker() {
      return Utils.containsBindMarker(value);
    }
  }

  static class IsNotNullClause extends AbstractClause {

    IsNotNullClause(String name) {
      super(name);
    }

    @Override
    void appendTo(StringBuilder sb, List values, CodecRegistry codecRegistry) {
      Utils.appendName(name, sb).append(" IS NOT NULL");
    }

    @Override
    Object firstValue() {
      return null;
    }

    @Override
    boolean containsBindMarker() {
      return false;
    }
  }

  static class InClause extends AbstractClause {

    private final List values;

    InClause(String name, Iterable values) {
      super(name);
      if (values == null) throw new IllegalArgumentException("Missing values for IN clause");

      this.values = Lists.newArrayList(values);

      if (this.values.size() > 65535)
        throw new IllegalArgumentException(
            "Too many values for IN clause, the maximum allowed is 65535");
    }

    @Override
    void appendTo(StringBuilder sb, List variables, CodecRegistry codecRegistry) {

      // We special case the case of just one bind marker because there is little
      // reasons to do:
      //    ... IN (?) ...
      // since in that case it's more elegant to use an equal. On the other side,
      // it is a lot more useful to do:
      //    ... IN ? ...
      // which binds the variable to the full list the IN is on.
      if (values.size() == 1 && values.get(0) instanceof BindMarker) {
        Utils.appendName(name, sb).append(" IN ").append(values.iterator().next());
        return;
      }

      Utils.appendName(name, sb).append(" IN (");
      Utils.joinAndAppendValues(sb, codecRegistry, values, variables).append(')');
    }

    @Override
    Object firstValue() {
      return values.isEmpty() ? null : values.get(0);
    }

    @Override
    boolean containsBindMarker() {
      for (Object value : values) if (Utils.containsBindMarker(value)) return true;
      return false;
    }
  }

  static class ContainsClause extends AbstractClause {

    private final Object value;

    ContainsClause(String name, Object value) {
      super(name);
      this.value = value;

      if (value == null) throw new IllegalArgumentException("Missing value for CONTAINS clause");
    }

    @Override
    void appendTo(StringBuilder sb, List variables, CodecRegistry codecRegistry) {
      Utils.appendName(name, sb).append(" CONTAINS ");
      Utils.appendValue(value, codecRegistry, sb, variables);
    }

    @Override
    Object firstValue() {
      return value;
    }

    @Override
    boolean containsBindMarker() {
      return Utils.containsBindMarker(value);
    }
  }

  static class ContainsKeyClause extends AbstractClause {

    private final Object value;

    ContainsKeyClause(String name, Object value) {
      super(name);
      this.value = value;

      if (value == null)
        throw new IllegalArgumentException("Missing value for CONTAINS KEY clause");
    }

    @Override
    void appendTo(StringBuilder sb, List variables, CodecRegistry codecRegistry) {
      Utils.appendName(name, sb).append(" CONTAINS KEY ");
      Utils.appendValue(value, codecRegistry, sb, variables);
    }

    @Override
    Object firstValue() {
      return value;
    }

    @Override
    boolean containsBindMarker() {
      return Utils.containsBindMarker(value);
    }
  }

  static class CompoundClause extends Clause {
    private String op;
    private final List names;
    private final List values;

    CompoundClause(Iterable names, String op, Iterable values) {
      this.op = op;
      this.names = Lists.newArrayList(names);
      this.values = Lists.newArrayList(values);
      if (this.names.size() != this.values.size())
        throw new IllegalArgumentException(
            String.format(
                "The number of names (%d) and values (%d) don't match",
                this.names.size(), this.values.size()));
    }

    @Override
    String name() {
      // This is only used for routing key purpose, and so far CompoundClause
      // are not allowed for the partitionKey anyway
      return null;
    }

    @Override
    Object firstValue() {
      // This is only used for routing key purpose, and so far CompoundClause
      // are not allowed for the partitionKey anyway
      return null;
    }

    @Override
    boolean containsBindMarker() {
      for (Object value : values) if (Utils.containsBindMarker(value)) return true;
      return false;
    }

    @Override
    void appendTo(StringBuilder sb, List variables, CodecRegistry codecRegistry) {
      sb.append("(");
      for (int i = 0; i < names.size(); i++) {
        if (i > 0) sb.append(",");
        Utils.appendName(names.get(i), sb);
      }
      sb.append(")").append(op).append("(");
      for (int i = 0; i < values.size(); i++) {
        if (i > 0) sb.append(",");
        Utils.appendValue(values.get(i), codecRegistry, sb, variables);
      }
      sb.append(")");
    }
  }

  static class CompoundInClause extends Clause {
    private final List names;
    private final List valueLists;

    public CompoundInClause(Iterable names, Iterable valueLists) {
      if (valueLists == null) throw new IllegalArgumentException("Missing values for IN clause");
      if (names == null) throw new IllegalArgumentException("Missing names for IN clause");

      this.names = Lists.newArrayList(names);
      this.valueLists = Lists.newArrayList();

      for (Object value : valueLists) {
        if (value instanceof Iterable) {
          List tuple = Lists.newArrayList((Iterable) value);
          if (tuple.size() != this.names.size()) {
            throw new IllegalArgumentException(
                String.format(
                    "The number of names (%d) and values (%d) don't match",
                    this.names.size(), tuple.size()));
          }
          this.valueLists.add(tuple);
        } else if (!(value instanceof BindMarker)) {
          throw new IllegalArgumentException(
              String.format(
                  "Wrong element type for values list, expected List or BindMarker, got %s",
                  value.getClass().getName()));
        } else {
          this.valueLists.add(value);
        }
      }
      if (this.valueLists.size() > 65535)
        throw new IllegalArgumentException(
            "Too many values for IN clause, the maximum allowed is 65535");
    }

    @Override
    String name() {
      // This is only used for routing key purpose, and so far CompoundClause
      // are not allowed for the partitionKey anyway
      return null;
    }

    @Override
    Object firstValue() {
      // This is only used for routing key purpose, and so far CompoundClause
      // are not allowed for the partitionKey anyway
      return null;
    }

    @Override
    boolean containsBindMarker() {
      return Utils.containsBindMarker(valueLists);
    }

    @Override
    void appendTo(StringBuilder sb, List variables, CodecRegistry codecRegistry) {
      sb.append("(");
      for (int i = 0; i < names.size(); i++) {
        if (i > 0) sb.append(",");
        Utils.appendName(names.get(i), sb);
      }
      sb.append(")").append(" IN ").append("(");
      for (int i = 0; i < valueLists.size(); i++) {
        if (i > 0) sb.append(",");

        Object elt = valueLists.get(i);

        if (elt instanceof BindMarker) {
          sb.append(elt);
        } else {
          List tuple = (List) elt;
          if (tuple.size() == 1 && tuple.get(0) instanceof BindMarker) {
            // Special case when there is only one bind marker: "IN ?" instead of "IN (?)"
            sb.append(tuple.get(0));
          } else {
            sb.append("(");
            Utils.joinAndAppendValues(sb, codecRegistry, (List) tuple, variables).append(')');
          }
        }
      }
      sb.append(")");
    }
  }
}