Docs For Class HarmoniEntryIterator

Description

EntryIterator provides access to these objects sequentially, one at a time.

The purpose of all Iterators is to to offer a way for OSID methods to return multiple values of a common type and not use an array. Returning an array may not be appropriate if the number of values returned is large or is fetched remotely. Iterators do not allow access to values by index, rather you must access values in sequence. Similarly, there is no way to go backwards through the sequence unless you place the values in a data structure, such as an array, that allows for access by index.

version: $Id: HarmoniEntryIterator.class.php,v 1.6 2007/09/04 20:25:43 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 3/1/06

Located in /harmoni/core/oki2/logging/HarmoniEntryIterator.class.php (line 33)

EntryIterator
   |
   --HarmoniEntryIterator

Direct descendents

Class	Description
SearchEntryIterator	EntryIterator provides access to these objects sequentially, one at a time.

Method Summary

object HarmoniEntryIterator (string $logName, object Type $formatType, object Type $priorityType, mixed $dbIndex)

void addColumnsAndOrder (object SelectQuery $query)

void addWhereClauses (object SelectQuery $query)

int count ()

object SelectQuery getBaseQuery ()

boolean hasNext ()

boolean hasNextEntry ()

void loadCount ()

void loadNext ()

object Entry next ()

object Entry nextEntry ()

void skipNext ()

Methods

Constructor HarmoniEntryIterator (line 47)

Constructor

since: 3/1/06
access: public

object HarmoniEntryIterator (string $logName, object Type $formatType, object Type $priorityType, mixed $dbIndex)

string $logName
object Type $formatType
object Type $priorityType

addColumnsAndOrder (line 345)

Add columns, orders, and limits to our query

since: 3/9/06
access: public

void addColumnsAndOrder (object SelectQuery $query)

object SelectQuery $query

addWhereClauses (line 366)

Add where clauses to the query

since: 3/9/06
access: public

void addWhereClauses (object SelectQuery $query)

object SelectQuery $query

Redefined in descendants as:

SearchEntryIterator::addWhereClauses() : Add where clauses to the query

count (line 186)

Gives the number of items in the iterator

public:

int count ()

getBaseQuery (line 325)

Answer the basic query

since: 3/9/06
access: public

object SelectQuery getBaseQuery ()

hasNext (line 127)

Return true if there is an additional Entry Description_IteratorHasNext2]

access: public
throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED

boolean hasNext ()

hasNextEntry (line 80)

Return true if there is an additional Entry Description_IteratorHasNext2]

access: public
throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED

boolean hasNextEntry ()

Redefinition of:

EntryIterator::hasNextEntry(): Return true if there is an additional Entry Description_IteratorHasNext2]

loadCount (line 197)

Load the number of results

since: 3/9/06
access: public

void loadCount ()

loadNext (line 222)

Load the next bunch of items

since: 3/1/06
access: public

void loadNext ()

next (line 151)

Return the next Entry.

access: public
throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, NO_MORE_ITERATOR_ELEMENTS

object Entry next ()

nextEntry (line 104)

Return the next Entry.

access: public
throws: object LoggingException An exception with one of the following messages defined in org.osid.logging.LoggingException may be thrown: UNIMPLEMENTED, OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, NO_MORE_ITERATOR_ELEMENTS

object Entry nextEntry ()

Redefinition of:

EntryIterator::nextEntry(): Return the next Entry.

skipNext (line 170)

Skips the next item in the iterator

public:

void skipNext ()

Inherited Methods

Inherited From EntryIterator

EntryIterator::hasNextEntry()
EntryIterator::nextEntry()