Package com.google.cloud.spanner

Class ForwardingResultSet

java.lang.Object

com.google.cloud.spanner.ForwardingStructReader

com.google.cloud.spanner.ForwardingResultSet

All Implemented Interfaces:

ProtobufResultSet, ResultSet, StructReader, AutoCloseable

Direct Known Subclasses:

ForwardingAsyncResultSet

public class ForwardingResultSet
extends ForwardingStructReader
implements ProtobufResultSet

Forwarding implementation of ResultSet that forwards all calls to a delegate.

Constructor Summary

Constructors

Constructor	Description
ForwardingResultSet(ResultSet delegate)
ForwardingResultSet(com.google.common.base.Supplier<? extends ResultSet> supplier)

Method Summary

Modifier and Type	Method	Description
boolean	canGetProtobufValue(int columnIndex)	Returns true if the protobuf value for the given column is still available.
void	close()	Explicitly close the result set, releasing any associated resources.
Struct	getCurrentRowAsStruct()	Creates an immutable version of the row that the result set is positioned over.
ResultSetMetadata	getMetadata()	Returns the ResultSetMetadata for this ResultSet.
com.google.protobuf.Value	getProtobufValue(int columnIndex)	Returns the column value as a protobuf value.
ResultSetStats	getStats()	Returns the ResultSetStats for the query only if the query was executed in either the PLAN or the PROFILE mode via the ReadContext.analyzeQuery(Statement, com.google.cloud.spanner.ReadContext.QueryAnalyzeMode) method or for DML statements in ReadContext.executeQuery(Statement, QueryOption...).
boolean	next()	Advances the result set to the next row, returning false if no such row exists.

Methods inherited from class com.google.cloud.spanner.ForwardingStructReader

checkValidState, getBigDecimal, getBigDecimal, getBigDecimalList, getBigDecimalList, getBoolean, getBoolean, getBooleanArray, getBooleanArray, getBooleanList, getBooleanList, getBytes, getBytes, getBytesList, getBytesList, getColumnCount, getColumnIndex, getColumnType, getColumnType, getDate, getDate, getDateList, getDateList, getDouble, getDouble, getDoubleArray, getDoubleArray, getDoubleList, getDoubleList, getFloat, getFloat, getFloatArray, getFloatArray, getFloatList, getFloatList, getJson, getJson, getJsonList, getJsonList, getLong, getLong, getLongArray, getLongArray, getLongList, getLongList, getPgJsonb, getPgJsonb, getPgJsonbList, getPgJsonbList, getProtoEnum, getProtoEnum, getProtoEnumList, getProtoEnumList, getProtoMessage, getProtoMessage, getProtoMessageList, getProtoMessageList, getString, getString, getStringList, getStringList, getStructList, getStructList, getTimestamp, getTimestamp, getTimestampList, getTimestampList, getType, getValue, getValue, isNull, isNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.cloud.spanner.StructReader

getBigDecimal, getBigDecimal, getBigDecimalList, getBigDecimalList, getBoolean, getBoolean, getBooleanArray, getBooleanArray, getBooleanList, getBooleanList, getBytes, getBytes, getBytesList, getBytesList, getColumnCount, getColumnIndex, getColumnType, getColumnType, getDate, getDate, getDateList, getDateList, getDouble, getDouble, getDoubleArray, getDoubleArray, getDoubleList, getDoubleList, getFloat, getFloat, getFloatArray, getFloatArray, getFloatList, getFloatList, getJson, getJson, getJsonList, getJsonList, getLong, getLong, getLongArray, getLongArray, getLongList, getLongList, getPgJsonb, getPgJsonb, getPgJsonbList, getPgJsonbList, getProtoEnum, getProtoEnum, getProtoEnumList, getProtoEnumList, getProtoMessage, getProtoMessage, getProtoMessageList, getProtoMessageList, getString, getString, getStringList, getStringList, getStructList, getStructList, getTimestamp, getTimestamp, getTimestampList, getTimestampList, getType, getValue, getValue, isNull, isNull

Constructor Details

ForwardingResultSet

public ForwardingResultSet(ResultSet delegate)

ForwardingResultSet

public ForwardingResultSet(com.google.common.base.Supplier<? extends ResultSet> supplier)

Method Details

next

public boolean next()
             throws SpannerException

Description copied from interface: ResultSet

Advances the result set to the next row, returning false if no such row exists. This method may block.

Specified by:

next in interface ResultSet

Throws:

SpannerException

canGetProtobufValue

public boolean canGetProtobufValue(int columnIndex)

Description copied from interface: ProtobufResultSet

Returns true if the protobuf value for the given column is still available.

Specified by:

canGetProtobufValue in interface ProtobufResultSet

getProtobufValue

public com.google.protobuf.Value getProtobufValue(int columnIndex)

Description copied from interface: ProtobufResultSet

Returns the column value as a protobuf value.

This is an internal method not intended for external usage.

This method may only be called before the column value has been decoded to a plain Java object. This means that the DecodeMode that is used for the ResultSet must be one of DecodeMode.LAZY_PER_ROW and DecodeMode.LAZY_PER_COL, and that the corresponding StructReader.getValue(int), StructReader.getBoolean(int), ... method may not yet have been called for the column.

Specified by:

getProtobufValue in interface ProtobufResultSet

getCurrentRowAsStruct

public Struct getCurrentRowAsStruct()

Description copied from interface: ResultSet

Creates an immutable version of the row that the result set is positioned over. This may involve copying internal data structures, and so converting all rows to Struct objects is generally more expensive than processing the ResultSet directly.

Specified by:

getCurrentRowAsStruct in interface ResultSet

close

public void close()

Description copied from interface: ResultSet

Explicitly close the result set, releasing any associated resources. This must always be called when disposing of a ResultSet before ResultSet.next() has returned false or raised an exception. Calling close() is also allowed if the result set has been fully consumed, so a recommended practice is to unconditionally close the result set once it is done with, typically using a try-with-resources construct.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ResultSet

getStats

public ResultSetStats getStats()

Description copied from interface: ResultSet

Returns the ResultSetStats for the query only if the query was executed in either the PLAN or the PROFILE mode via the ReadContext.analyzeQuery(Statement, com.google.cloud.spanner.ReadContext.QueryAnalyzeMode) method or for DML statements in ReadContext.executeQuery(Statement, QueryOption...). Attempts to call this method on a ResultSet not obtained from analyzeQuery or executeQuery will return a null ResultSetStats. This method must be called after ResultSet.next() has returned @{code false}. Calling it before that will result in null ResultSetStats too.

Specified by:

getStats in interface ResultSet

getMetadata

public ResultSetMetadata getMetadata()

Description copied from interface: ResultSet

Returns the ResultSetMetadata for this ResultSet. This is method may only be called after calling ResultSet.next() at least once.

Specified by:

getMetadata in interface ResultSet