Package 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetRecordsFromCollectionResponse.Info	A set of string constants for the GetRecordsFromCollectionResponse parameter info.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<T>	getData()	If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection.
Map<String,String>	getInfo()	Additional information.
List<String>	getRecordIds()	If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID for each object.
String	getTableName()	Value of tableName.
List<String>	getTypeNames()	The type IDs of the corresponding records in data or recordsJson.
int	hashCode()
GetRecordsFromCollectionResponse<T>	setData(List<T> data)	If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection.
GetRecordsFromCollectionResponse<T>	setInfo(Map<String,String> info)	Additional information.
GetRecordsFromCollectionResponse<T>	setRecordIds(List<String> recordIds)	If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID for each object.
GetRecordsFromCollectionResponse<T>	setTableName(String tableName)	Value of tableName.
GetRecordsFromCollectionResponse<T>	setTypeNames(List<String> typeNames)	The type IDs of the corresponding records in data or recordsJson.
String	toString()

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.

Method Detail

getTableName

public String getTableName()

Value of tableName.

Returns:

The current value of tableName.

setTableName

public GetRecordsFromCollectionResponse<T> setTableName(String tableName)

Value of tableName.

Parameters:

tableName - The new value for tableName.

Returns:

this to mimic the builder pattern.

getTypeNames

public List<String> getTypeNames()

The type IDs of the corresponding records in data or recordsJson. This is useful when tableName is a heterogeneous collection (collections containing tables of different types).

Returns:

The current value of typeNames.

setTypeNames

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

The type IDs of the corresponding records in data or recordsJson. This is useful when tableName is a heterogeneous collection (collections containing tables of different types).

Parameters:

typeNames - The new value for typeNames.

Returns:

this to mimic the builder pattern.

getData

public List<T> getData()

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:

The current value of data.

setData

public GetRecordsFromCollectionResponse<T> setData(List<T> 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.

Parameters:

data - The new value for data.

Returns:

this to mimic the builder pattern.

getRecordIds

public List<String> getRecordIds()

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

Returns:

The current value of recordIds.

setRecordIds

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

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

Parameters:

recordIds - The new value for recordIds.

Returns:

this to mimic the builder pattern.

getInfo

public Map<String,String> getInfo()

Additional information.

• TOTAL_NUMBER_OF_RECORDS: Total number of records.
• HAS_MORE_RECORDS: Too many records. Returned a partial set. Supported values:
  • TRUE
  • FALSE

The default value is an empty Map.

Returns:

The current value of info.

setInfo

public GetRecordsFromCollectionResponse<T> setInfo(Map<String,String> info)

Additional information.

• TOTAL_NUMBER_OF_RECORDS: Total number of records.
• HAS_MORE_RECORDS: Too many records. Returned a partial set. Supported values:
  • TRUE
  • FALSE

The default value is an empty Map.

Parameters:

info - The new value for info.

Returns:

this to mimic the builder pattern.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object