Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Library.DataSource.Queries.AQueryIterator Class Reference

This class allows a query to behave as an iterable object. More...

+ Inheritance diagram for Library.DataSource.Queries.AQueryIterator:

Public Member Functions

def __init__
 Construct a new instance of the iterator that will iterate using the specified query and return rows as instances of the specified row class. More...
 
def init
 Initializer.
 
def next
 Retrieve the next row from the query. More...
 
def Query
 Retrieve a reference to the Query instance used by the iterator. More...
 
def __iter__
 Retrieve a reference to the iterator object. More...
 
def __len__
 Retrieve the "length" of the iterator object – the total number of rows returned by the query.
 
- Public Member Functions inherited from Library.Base.Events.AnEventfulObject
def __init__
 Constructor. More...
 
def init
 Initializer.
 
def __del__
 Destructor.
 
def parseParams
 Parse the specified parameters, looking for named events and setting event handlers as appropriate. More...
 
def generate
 Generate the named event.
 
def update
 Update the events generated by the object.
 
def error
 Generate an error event. More...
 
def toString
 Construct a string representation of the object. More...
 
def on
 Set the handler for the specified event. More...
 
def onMultiple
 Set handlers for multiple events. More...
 
def handlerFor
 Retrieve the handler for the specified event. More...
 
def generates
 Determine whether or not the object generates the named event. More...
 
def __getitem__
 Retrieve the value of the named property.
 
def __setitem__
 Set the value of the named property.
 
- Public Member Functions inherited from Library.Base.Classwork.AnObject
def init
 Initialize a new object instance. More...
 
def __init__
 Construct and initialize a new instance of AnObject. More...
 
def __del__
 Destroy the object instance. More...
 
def displayName
 Construct a "pretty" display name for the class instance, based on the name of its class. More...
 
def implements
 Determine whether the class instance is related to the specified class. More...
 
def toString
 Return a string representation of the class, suitable for output to a console or text-based device. More...
 
def __str__
 Return a string representation of the class. More...
 
def classname
 Return the name of the class from which the instance was created. More...
 
def name
 Return the name of the class. More...
 
- Public Member Functions inherited from Library.String.Utilities.IsPrintable
def toString
 Return a string representation of the class conveniently. More...
 
def __str__
 Return a string representation of the class. More...
 
def printTo
 Print a string representation of the class to the specified stream. More...
 

Detailed Description

This class allows a query to behave as an iterable object.

Constructor & Destructor Documentation

def Library.DataSource.Queries.AQueryIterator.__init__ (   Self,
  ThisQuery,
  RowClass = None,
  rowParams = None,
  params 
)

Construct a new instance of the iterator that will iterate using the specified query and return rows as instances of the specified row class.

Member Function Documentation

def Library.DataSource.Queries.AQueryIterator.__iter__ (   Self)

Retrieve a reference to the iterator object.

This method is necessary to allow the iterator to be used as part of a Python for..in statement.

def Library.DataSource.Queries.AQueryIterator.next (   Self)

Retrieve the next row from the query.

This method generates the nextRecord event.

def Library.DataSource.Queries.AQueryIterator.Query (   Self)

Retrieve a reference to the Query instance used by the iterator.


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