com.google.api.ads.admanager.axis.utils.v202311.StatementBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dfp-axis Show documentation
Ad Manager specific Axis components.
There is a newer version: 5.6.0
// Copyright 2015 Google Inc. All Rights Reserved.
//
// 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.google.api.ads.admanager.axis.utils.v202311;

import com.google.api.ads.admanager.axis.v202311.Statement;
import com.google.api.ads.admanager.axis.v202311.String_ValueMapEntry;
import com.google.api.ads.admanager.axis.v202311.Value;
import com.google.api.ads.admanager.lib.utils.QueryBuilder;
import com.google.api.ads.admanager.lib.utils.QueryBuilderInterface;
import com.google.api.ads.common.lib.utils.Maps;
import com.google.common.annotations.VisibleForTesting;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import java.util.Map;

/**
 * {@code StatementBuilder} allows for statements to be constructed in parts.
 *
 * Typical usage is:
 *
 * 
 * StatementBuilder statementBuilder = new StatementBuilder()
 *     .where("lastModifiedDateTime > :yesterday AND type = :type")
 *     .orderBy("name DESC")
 *     .limit(200)
 *     .offset(20)
 *     .withBindVariableValue("yesterday",
 *         DateTimes.fromDate(new org.joda.time.DateTime().minusDays(1).toDate()))
 *     .withBindVariableValue("type", "Type")
 *
 * Statement statement = statementBuilder.toStatement();
 * //...
 * statementBuilder.increaseOffsetBy(20);
 * statement = statementBuilder.toStatement();
 * 
 */
public final class StatementBuilder {

  public static final int SUGGESTED_PAGE_LIMIT = 500;

  private final QueryBuilderInterface queryBuilder;

  /** Constructs a statement builder. */
  public StatementBuilder() {
    this(new QueryBuilder());
  }

  /** Constructor for testing. */
  @VisibleForTesting
  StatementBuilder(QueryBuilderInterface queryBuilder) {
    this.queryBuilder = queryBuilder;
  }

  /**
   * Adds a bind variable value to the statement. The value will converted according to {@link
   * Pql#createValue(Object)}. If the value is of type {@code Value}, no conversion will be done.
   *
   * @param key the value key
   * @param value the bind variable value
   * @return a reference to this object
   */
  @CanIgnoreReturnValue
  public StatementBuilder withBindVariableValue(String key, Object value) {
    return withBindVariableValue(key, Pql.createValue(value));
  }

  /**
   * Adds a bind variable value to the statement.
   *
   * @param key the value key
   * @param value the bind variable value
   * @return a reference to this object
   */
  @CanIgnoreReturnValue
  public StatementBuilder withBindVariableValue(String key, Value value) {
    queryBuilder.withBindVariableValue(key, value);
    return this;
  }

  /**
   * Gets the {@link Statement} representing the state of this statement builder.
   *
   * @return the {@link Statement}
   */
  public Statement toStatement() {
    Statement statement = new Statement();
    statement.setQuery(queryBuilder.buildQuery());
    statement.setValues(
        Maps.toList(queryBuilder.getBindVariableMap(), String_ValueMapEntry.class)
            .toArray(new String_ValueMapEntry[] {}));
    return statement;
  }

  @CanIgnoreReturnValue
  public StatementBuilder select(String columns) {
    queryBuilder.select(columns);
    return this;
  }

  @CanIgnoreReturnValue
  public StatementBuilder from(String table) {
    queryBuilder.from(table);
    return this;
  }

  @CanIgnoreReturnValue
  public StatementBuilder where(String conditions) {
    queryBuilder.where(conditions);
    return this;
  }

  @CanIgnoreReturnValue
  public StatementBuilder limit(Integer count) {
    queryBuilder.limit(count);
    return this;
  }

  @CanIgnoreReturnValue
  public StatementBuilder offset(Integer count) {
    queryBuilder.offset(count);
    return this;
  }

  @CanIgnoreReturnValue
  public StatementBuilder increaseOffsetBy(Integer amount) {
    queryBuilder.increaseOffsetBy(amount);
    return this;
  }

  public Integer getOffset() {
    return queryBuilder.getOffset();
  }

  @CanIgnoreReturnValue
  public StatementBuilder removeLimitAndOffset() {
    queryBuilder.removeLimitAndOffset();
    return this;
  }

  @CanIgnoreReturnValue
  public StatementBuilder orderBy(String orderBy) {
    queryBuilder.orderBy(orderBy);
    return this;
  }

  public Map getBindVariableMap() {
    return queryBuilder.getBindVariableMap();
  }

  public String buildQuery() {
    return queryBuilder.buildQuery();
  }
}