Xale::DataStructure::ResultSet Class Reference

Read-only temporary dataset. More...

#include <ResultSet.h>

Inheritance diagram for Xale::DataStructure::ResultSet:

Collaboration diagram for Xale::DataStructure::ResultSet:

Public Member Functions
	ResultSet (const std::string &name="result")
	Constructor.
const std::string &	getName () const override
	Get result set name.
const std::vector< ColumnDefinition > &	getSchema () const override
	Get schema.
const std::vector< Row > &	getRows () const override
	Get all rows.
size_t	getRowCount () const override
	Get row count.
size_t	getColumnCount () const override
	Get column count.
bool	isEmpty () const override
	Check if empty.
bool	isMutable () const override
	Check if mutable.
void	addColumn (const ColumnDefinition &column)
	Add column definition (used by executor).
void	addRow (const Row &row)
	Add a row (used by executor).
const Row &	getRow (size_t index) const
	Get a specific row.

Detailed Description

Read-only temporary dataset.

Constructor & Destructor Documentation

ResultSet()

Xale::DataStructure::ResultSet::ResultSet ( const std::string & name = "result" )

explicit

Constructor.

Parameters

name	Result set name (optional)

Member Function Documentation

addColumn()

void Xale::DataStructure::ResultSet::addColumn

(

const ColumnDefinition &

column

)

Add column definition (used by executor).

Parameters

column

Column definition

addRow()

void Xale::DataStructure::ResultSet::addRow

(

const Row &

row

)

Add a row (used by executor).

Parameters

row	Row to add

getColumnCount()

size_t Xale::DataStructure::ResultSet::getColumnCount ( ) const

overridevirtual

Get column count.

Returns

Number of columns

Implements Xale::DataStructure::IDataTemplate.

getName()

const std::string & Xale::DataStructure::ResultSet::getName ( ) const

overridevirtual

Get result set name.

Returns

Name

Implements Xale::DataStructure::IDataTemplate.

getRow()

const Row & Xale::DataStructure::ResultSet::getRow

(

size_t

index

)

const

Get a specific row.

Parameters

index

Row index

Returns

Reference to the row

Exceptions

DbException

if index out of bounds

getRowCount()

size_t Xale::DataStructure::ResultSet::getRowCount ( ) const

overridevirtual

Get row count.

Returns

Number of rows

Implements Xale::DataStructure::IDataTemplate.

getRows()

const std::vector< Row > & Xale::DataStructure::ResultSet::getRows ( ) const

overridevirtual

Get all rows.

Returns

Vector of rows

Implements Xale::DataStructure::IDataTemplate.

getSchema()

const std::vector< ColumnDefinition > & Xale::DataStructure::ResultSet::getSchema ( ) const

overridevirtual

Get schema.

Returns

Vector of column definitions

Implements Xale::DataStructure::IDataTemplate.

isEmpty()

bool Xale::DataStructure::ResultSet::isEmpty ( ) const

overridevirtual

Check if empty.

Returns

True if empty

Implements Xale::DataStructure::IDataTemplate.

isMutable()

bool Xale::DataStructure::ResultSet::isMutable ( ) const

overridevirtual

Check if mutable.

Returns

Always false for ResultSet

Implements Xale::DataStructure::IDataTemplate.

---

The documentation for this class was generated from the following files:

• include/DataStructure/ResultSet.h
• src/DataStructure/ResultSet.cpp