com.gpudb.protocol

Class GetRecordsFromCollectionResponse<T>

java.lang.Object

com.gpudb.protocol.GetRecordsFromCollectionResponse<T>

Type Parameters:

T - The type of object being processed.

public class GetRecordsFromCollectionResponse<T>
extends Object

A set of results returned by GPUdb.getRecordsFromCollection(Object, GetRecordsFromCollectionRequest). The Raw version of this method can be used to specify the encoding scheme of the response.

Constructor Summary

Constructors

Constructor and Description
GetRecordsFromCollectionResponse() Constructs a GetRecordsFromCollectionResponse object with default parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) The Raw version of this method can be used to specify the encoding scheme of the response.
List<T>	getData() The Raw version of this method can be used to specify the encoding scheme of the response.
List<String>	getRecordIds() The Raw version of this method can be used to specify the encoding scheme of the response.
String	getTableName() The Raw version of this method can be used to specify the encoding scheme of the response.
List<String>	getTypeNames() The Raw version of this method can be used to specify the encoding scheme of the response.
int	hashCode() The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsFromCollectionResponse<T>	setData(List<T> data) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsFromCollectionResponse<T>	setRecordIds(List<String> recordIds) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsFromCollectionResponse<T>	setTableName(String tableName) The Raw version of this method can be used to specify the encoding scheme of the response.
GetRecordsFromCollectionResponse<T>	setTypeNames(List<String> typeNames) The Raw version of this method can be used to specify the encoding scheme of the response.
String	toString() The Raw version of this method can be used to specify the encoding scheme of the response.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetRecordsFromCollectionResponse

public GetRecordsFromCollectionResponse()

Constructs a GetRecordsFromCollectionResponse object with default parameters. The Raw version of this method can be used to specify the encoding scheme of the response.

Method Detail

getTableName

public String getTableName()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

Value of tableName.

setTableName

public GetRecordsFromCollectionResponse<T> setTableName(String tableName)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

tableName - Value of tableName.

Returns:

this to mimic the builder pattern.

getTypeNames

public List<String> getTypeNames()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

The type IDs of the corresponding records in recordsBinary or recordsJson. This is useful when tableName is a heterogeneous collection (i.e. the child tables are not all of the same type).

setTypeNames

public GetRecordsFromCollectionResponse<T> setTypeNames(List<String> typeNames)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

typeNames - The type IDs of the corresponding records in recordsBinary or recordsJson. This is useful when tableName is a heterogeneous collection (i.e. the child tables are not all of the same type).

Returns:

this to mimic the builder pattern.

getData

public List<T> getData()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. Otherwise, empty list.

setData

public GetRecordsFromCollectionResponse<T> setData(List<T> data)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

data - If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. Otherwise, empty list.

Returns:

this to mimic the builder pattern.

getRecordIds

public List<String> getRecordIds()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

If the 'return_record_ids' option of the request was 'true', then this list contains the internal GPUdb id for each object. Otherwise it will be empty.

setRecordIds

public GetRecordsFromCollectionResponse<T> setRecordIds(List<String> recordIds)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

recordIds - If the 'return_record_ids' option of the request was 'true', then this list contains the internal GPUdb id for each object. Otherwise it will be empty.

Returns:

this to mimic the builder pattern.

equals

public boolean equals(Object obj)

The Raw version of this method can be used to specify the encoding scheme of the response.

Overrides:

equals in class Object

toString

public String toString()

The Raw version of this method can be used to specify the encoding scheme of the response.

Overrides:

toString in class Object

hashCode

public int hashCode()

The Raw version of this method can be used to specify the encoding scheme of the response.

Overrides:

hashCode in class Object