com.google.api.ads.dfp.axis.utils.v201306

Class Pql

java.lang.Object

com.google.api.ads.dfp.axis.utils.v201306.Pql

public final class Pql
extends Object

A utility class for handling PQL objects. A typical use case is to combine result sets from the PublisherQueryLanguageService to then create a CSV such as:

 
 ResultSet combinedResultSet = null
 do {
   ResultSet resultSet = pqlService.select(pagedStatement);
   combinedResultSet = (combinedResultSet == null) ? resultSet :
       Pql.combineResultSet(combinedResultSet, resultSet);
   // ...
 } while(!finishedCollectingResultSets)
 //...
 CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
 
 

Author:

Adam Rogal.

Method Summary

Methods

Modifier and Type	Method and Description
static ResultSet	combineResultSets(ResultSet first, ResultSet second) Combines the first and second result sets, if and only if, the columns of both result sets match.
static Value	createValue(Object value) Creates a Value from the value i.e.
static List<String>	getColumnLabels(ResultSet resultSet) Gets the column labels for the result set.
static List<String>	getRowStringValues(Row row) Gets the values in a row of the result set in the form of a string list.
static String	resultSetToString(ResultSet resultSet) Gets the result set as a table representation in the form of:
static List<String[]>	resultSetToStringArrayList(ResultSet resultSet) Gets the result set as list of string arrays, which can be transformed to a CSV using CsvFiles such as
static String	toString(Value value) Creates a String from the Value.

Methods inherited from class java.lang.Object

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

Method Detail

createValue

public static Value createValue(Object value)

Creates a Value from the value i.e. a TextValue for a value of type String, BooleanValue for type Boolean, NumberValue for type Double, Long, or Integer, DateTimeValue for type DateTime, and DateValue for type Date. If the value is a Value, the value is returned. If the value is null, an empty TextValue is returned.

Parameters:

value - the value to convert

Returns:

the constructed value of the appropriate type

Throws:

IllegalArgumentException - if value cannot be converted

toString

public static String toString(Value value)

Creates a String from the Value. Date and DateTime values are converted using the rules of DateTimes.toString(Date) and DateTimes.toStringWithTimeZone(DateTime) respectively.

Parameters:

value - the value to convert

Returns:

the string representation of the value

Throws:

IllegalArgumentException - if value cannot be converted

resultSetToStringArrayList

public static List<String[]> resultSetToStringArrayList(ResultSet resultSet)

Gets the result set as list of string arrays, which can be transformed to a CSV using CsvFiles such as

 
 ResultSet combinedResultSet = Pql.combineResultSet(resultSet1, resultSet2);
 //...
 combinedResultSet = Pql.combineResultSet(combinedResultSet, resultSet3);
 CsvFiles.writeCsv(Pql.resultSetToStringArrayList(combinedResultSet), filePath);
 
 

Parameters:

resultSet - the result set to convert to a CSV compatible format

Returns:

a list of string arrays representing the result set

resultSetToString

public static String resultSetToString(ResultSet resultSet)
                                throws IllegalAccessException

Gets the result set as a table representation in the form of:

 +-------+-------+-------+
 |column1|column2|column3|
 +-------+-------+-------+
 |value1 |value2 |value3 |
 +-------+-------+-------+
 |value1 |value2 |value3 |
 +-------+-------+-------+
 

Parameters:

resultSet - the result set to display as a string

Returns:

the string representation of result set as a table

Throws:

IllegalAccessException - if the values of the result set cannot be accessed

getColumnLabels

public static List<String> getColumnLabels(ResultSet resultSet)

Gets the column labels for the result set.

Parameters:

resultSet - the result set to get the column labels for

Returns:

the string list of column labels

getRowStringValues

public static List<String> getRowStringValues(Row row)

Gets the values in a row of the result set in the form of a string list.

Parameters:

row - the row to get the values for

Returns:

the string list of the row values

combineResultSets

public static ResultSet combineResultSets(ResultSet first,
                          ResultSet second)

Combines the first and second result sets, if and only if, the columns of both result sets match.

Throws:

IllegalArgumentException - if the columns of the first result set don't match the second