libgdamm  4.99.7
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gnome::Gda::Batch Class Reference

Multiple SQL statements grouped together. More...

Inheritance diagram for Gnome::Gda::Batch:
Inheritance graph
[legend]
Collaboration diagram for Gnome::Gda::Batch:
Collaboration graph
[legend]

Public Types

typedef std::vector
< Glib::RefPtr< const
Statement > > 
StatementVector
 

Public Member Functions

virtual ~Batch ()
 
GdaBatch* gobj ()
 Provides access to the underlying C GObject. More...
 
const GdaBatch* gobj () const
 Provides access to the underlying C GObject. More...
 
GdaBatch* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::RefPtr< Batchcopy ()
 Copy constructor. More...
 
void add_statement (const Glib::RefPtr< Statement >& stmt)
 Add stmt to the list of statements managed by batch. More...
 
void remove_statement (const Glib::RefPtr< Statement >& stmt)
 Removes stmt from the list of statements managed by batch. More...
 
Glib::ustring serialize () const
 Creates a string representing the contents of batch. More...
 
StatementVector get_statements () const
 Get a list of the Gda::Statement objects contained in batch. More...
 
bool get_parameters (Glib::RefPtr< Set >& out_params)
 Get a new Gda::Set object which groups all the execution parameters which stmt needs. More...
 
Glib::SignalProxy1< void,
Glib::RefPtr< Statement > > 
signal_changed ()
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static Glib::RefPtr< Batchcreate ()
 

Protected Member Functions

 Batch ()
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gnome::Gda::Batchwrap (GdaBatch* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Multiple SQL statements grouped together.

The Gda::Batch object represents one or more SQL statements (as Gda::Statement objects) in a single object. A Gda::Batch can either be built "manually" by assembling together several Gda::Statement objects, or from an SQL string using a Gda::SqlParser object.

Member Typedef Documentation

Constructor & Destructor Documentation

virtual Gnome::Gda::Batch::~Batch ( )
virtual
Gnome::Gda::Batch::Batch ( )
protected

Member Function Documentation

void Gnome::Gda::Batch::add_statement ( const Glib::RefPtr< Statement >&  stmt)

Add stmt to the list of statements managed by batch.

A Gda::Statement object can be added multiple times to a Gda::Batch object.

Parameters
stmtA statement to add to batch's statements list.
Glib::RefPtr<Batch> Gnome::Gda::Batch::copy ( )

Copy constructor.

Returns
A the new copy of orig.
static Glib::RefPtr<Batch> Gnome::Gda::Batch::create ( )
static
bool Gnome::Gda::Batch::get_parameters ( Glib::RefPtr< Set >&  out_params)

Get a new Gda::Set object which groups all the execution parameters which stmt needs.

This new object is returned though out_params.

Note that if stmt does not need any parameter, then out_params is set to 0.

Parameters
out_paramsA place to store a new Gda::Set object, or 0.
Returns
true if no error occurred.
StatementVector Gnome::Gda::Batch::get_statements ( ) const

Get a list of the Gda::Statement objects contained in batch.

Returns
A list of Gda::Statement which should not be modified.
static GType Gnome::Gda::Batch::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

GdaBatch* Gnome::Gda::Batch::gobj ( )
inline

Provides access to the underlying C GObject.

const GdaBatch* Gnome::Gda::Batch::gobj ( ) const
inline

Provides access to the underlying C GObject.

GdaBatch* Gnome::Gda::Batch::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void Gnome::Gda::Batch::remove_statement ( const Glib::RefPtr< Statement >&  stmt)

Removes stmt from the list of statements managed by batch.

If stmt is present several times in batch's statements' list, then only the first one is removed.

Parameters
stmtA statement to remove from batch's statements list.
Glib::ustring Gnome::Gda::Batch::serialize ( ) const

Creates a string representing the contents of batch.

Returns
A string containing the serialized version of batch.
Glib::SignalProxy1< void,Glib::RefPtr<Statement> > Gnome::Gda::Batch::signal_changed ( )
Slot Prototype:
void on_my_changed(Glib::RefPtr<Statement> stmt)

Friends And Related Function Documentation

Glib::RefPtr< Gnome::Gda::Batch > wrap ( GdaBatch *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

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