package io.vertx.ext.sql;

import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;

import java.util.ArrayList;
import java.util.List;
import java.util.TreeMap;

Represents the results of a SQL query.

It contains a list for the column names of the results, and a list of JsonArray - one for each row of the results.

Author:Tim Fox
/** * Represents the results of a SQL query. * <p> * It contains a list for the column names of the results, and a list of {@code JsonArray} - one for each row of the * results. * * @author <a href="http://tfox.org">Tim Fox</a> */
@DataObject(generateConverter = true) public class ResultSet { private List<String> columnNames; private List<JsonArray> results; private List<JsonObject> rows; private JsonArray output; // chained result sets private ResultSet next;
Default constructor
/** * Default constructor */
public ResultSet() { }
Copy constructor
Params:
  • other – result-set to copy
/** * Copy constructor * * @param other result-set to copy */
public ResultSet(ResultSet other) { this.columnNames = other.columnNames; this.results = other.results; this.output = other.output; this.next = other.next; }
Create a result-set
Params:
  • columnNames – the column names
  • results – the results
/** * Create a result-set * * @param columnNames the column names * @param results the results */
public ResultSet(List<String> columnNames, List<JsonArray> results, ResultSet next) { this.columnNames = columnNames; this.results = results; this.next = next; }
Create a result-set from JSON
Params:
  • json – the json
/** * Create a result-set from JSON * * @param json the json */
@SuppressWarnings("unchecked") public ResultSet(JsonObject json) { ResultSetConverter.fromJson(json, this); }
Convert to JSON
Returns:json object
/** * Convert to JSON * * @return json object */
public JsonObject toJson() { JsonObject obj = new JsonObject(); ResultSetConverter.toJson(this, obj); return obj; }
Get the results
Returns:the results
/** * Get the results * * @return the results */
public List<JsonArray> getResults() { return results; } public ResultSet setResults(List<JsonArray> results) { this.results = results; return this; }
Get the registered outputs
Returns:the outputs
/** * Get the registered outputs * * @return the outputs */
public JsonArray getOutput() { return output; } public ResultSet setOutput(JsonArray output) { this.output = output; return this; }
Get the column names
Returns:the column names
/** * Get the column names * * @return the column names */
public List<String> getColumnNames() { return columnNames; } public ResultSet setColumnNames(List<String> columnNames) { this.columnNames = columnNames; return this; }
Get the next result set
Returns:the next resultset
/** * Get the next result set * * @return the next resultset */
public ResultSet getNext() { return next; } public ResultSet setNext(ResultSet next) { this.next = next; return this; }
Get the rows - each row represented as a JsonObject where the keys are the column names and the values are the column values. Beware that it's legal for a query result in SQL to contain duplicate column names, in which case one will overwrite the other if using this method. If that's the case use getResults instead. Be aware that column names are defined as returned by the database, this means that even if your SQL statement is for example:
SELECT a, b FROM table
the column names are not required to be:
a
and
b
and could be in fact
A
and
B
. For cases when there is the need for case insentivitity you should see getRows(boolean)
Returns: the rows represented as JSON object instances
/** * Get the rows - each row represented as a JsonObject where the keys are the column names and the values are * the column values. * * Beware that it's legal for a query result in SQL to contain duplicate column names, in which case one will * overwrite the other if using this method. If that's the case use {@link #getResults} instead. * * Be aware that column names are defined as returned by the database, this means that even if your SQL statement * is for example: <pre>SELECT a, b FROM table</pre> the column names are not required to be: <pre>a</pre> and * <pre>b</pre> and could be in fact <pre>A</pre> and <pre>B</pre>. * * For cases when there is the need for case insentivitity you should see {@link #getRows(boolean)} * * @return the rows represented as JSON object instances */
public List<JsonObject> getRows() { return getRows(false); }
Get the rows - each row represented as a JsonObject where the keys are the column names and the values are the column values. Beware that it's legal for a query result in SQL to contain duplicate column names, in which case one will overwrite the other if using this method. If that's the case use getResults instead. Special note, when encoding the row JSON to a String or Buffer the column names will be as they returned by the database server regardless of the case sensitivity chosen on this method call.
Params:
  • caseInsensitive – - treat column names as case insensitive, i.e.: FoO equals foo equals FOO
Returns: the rows represented as JSON object instances
/** * Get the rows - each row represented as a JsonObject where the keys are the column names and the values are * the column values. * * Beware that it's legal for a query result in SQL to contain duplicate column names, in which case one will * overwrite the other if using this method. If that's the case use {@link #getResults} instead. * * Special note, when encoding the row JSON to a String or Buffer the column names will be as they returned by the * database server regardless of the case sensitivity chosen on this method call. * * @param caseInsensitive - treat column names as case insensitive, i.e.: FoO equals foo equals FOO * * @return the rows represented as JSON object instances */
public List<JsonObject> getRows(boolean caseInsensitive) { if (rows == null) { rows = new ArrayList<>(results.size()); int cols = columnNames.size(); for (JsonArray result: results) { JsonObject row = caseInsensitive ? new JsonObject(new TreeMap<>(String.CASE_INSENSITIVE_ORDER)) : new JsonObject(); for (int i = 0; i < cols; i++) { row.put(columnNames.get(i), result.getValue(i)); } rows.add(row); } } return rows; }
Return the number of rows in the result set
Returns:the number of rows
/** * Return the number of rows in the result set * * @return the number of rows */
public int getNumRows() { return results.size(); }
Return the number of columns in the result set
Returns:the number of columns
/** * Return the number of columns in the result set * * @return the number of columns */
public int getNumColumns() { return columnNames.size(); } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; ResultSet resultSet = (ResultSet) o; if (columnNames != null ? !columnNames.equals(resultSet.columnNames) : resultSet.columnNames != null) return false; if (results != null ? !results.equals(resultSet.results) : resultSet.results != null) return false; if (next != null ? !next.equals(resultSet.next) : resultSet.next != null) return false; return true; } @Override public int hashCode() { int result = columnNames != null ? columnNames.hashCode() : 0; result = 31 * result + (results != null ? results.hashCode() : 0); result = 31 * result + (next != null ? next.hashCode() : 0); return result; } }