com.google.api.ads.admanager.jaxws.utils.v202205

Class StatementBuilder

java.lang.Object

com.google.api.ads.admanager.jaxws.utils.v202205.StatementBuilder

public final class StatementBuilder
extends Object

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();
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	SUGGESTED_PAGE_LIMIT

Constructor Summary

Constructors

Constructor and Description
StatementBuilder() Constructs a statement builder.

Method Summary

Modifier and Type	Method and Description
String	buildQuery()
StatementBuilder	from(String table)
Map<String,com.google.api.ads.admanager.jaxws.v202205.Value>	getBindVariableMap()
Integer	getOffset()
StatementBuilder	increaseOffsetBy(Integer amount)
StatementBuilder	limit(Integer count)
StatementBuilder	offset(Integer count)
StatementBuilder	orderBy(String orderBy)
StatementBuilder	removeLimitAndOffset()
StatementBuilder	select(String columns)
com.google.api.ads.admanager.jaxws.v202205.Statement	toStatement() Gets the Statement representing the state of this statement builder.
StatementBuilder	where(String conditions)
StatementBuilder	withBindVariableValue(String key, Object value) Adds a bind variable value to the statement.
StatementBuilder	withBindVariableValue(String key, com.google.api.ads.admanager.jaxws.v202205.Value value) Adds a bind variable value to the statement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUGGESTED_PAGE_LIMIT

public static final int SUGGESTED_PAGE_LIMIT

See Also:

Constant Field Values

Constructor Detail

StatementBuilder

public StatementBuilder()

Constructs a statement builder.

Method Detail

withBindVariableValue

@CanIgnoreReturnValue
public StatementBuilder withBindVariableValue(String key,
                                                                    Object value)

Adds a bind variable value to the statement. The value will converted according to Pql.createValue(Object). If the value is of type Value, no conversion will be done.

Parameters:

key - the value key

value - the bind variable value

Returns:

a reference to this object

withBindVariableValue

@CanIgnoreReturnValue
public StatementBuilder withBindVariableValue(String key,
                                                                    com.google.api.ads.admanager.jaxws.v202205.Value value)

Adds a bind variable value to the statement.

Parameters:

key - the value key

value - the bind variable value

Returns:

a reference to this object

toStatement

public com.google.api.ads.admanager.jaxws.v202205.Statement toStatement()

Gets the Statement representing the state of this statement builder.

Returns:

the Statement

select

@CanIgnoreReturnValue
public StatementBuilder select(String columns)

from

@CanIgnoreReturnValue
public StatementBuilder from(String table)

where

@CanIgnoreReturnValue
public StatementBuilder where(String conditions)

limit

@CanIgnoreReturnValue
public StatementBuilder limit(Integer count)

offset

@CanIgnoreReturnValue
public StatementBuilder offset(Integer count)

increaseOffsetBy

@CanIgnoreReturnValue
public StatementBuilder increaseOffsetBy(Integer amount)

getOffset

public Integer getOffset()

removeLimitAndOffset

@CanIgnoreReturnValue
public StatementBuilder removeLimitAndOffset()

orderBy

@CanIgnoreReturnValue
public StatementBuilder orderBy(String orderBy)

getBindVariableMap

public Map<String,com.google.api.ads.admanager.jaxws.v202205.Value> getBindVariableMap()

buildQuery

public String buildQuery()