Callable

Class

DataFaucet 1.0 Beta

FRAMES

datafaucet.system
Class iterator

WEB-INF.cftags.component
        datafaucet.system.iterator

public class iterator
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

Constructor Summary
`init(query query, any record)`

Method Summary
`numeric`	`back()` moves to and loads the previous record - stops at zero - returns the index
`numeric`	`first()` moves to the first record
`numeric`	`getIndex()` returns the current index of the iterator
`query`	`getQuery()` returns the query loaded into the iterator
`any`	`getRecord()` returns the active record object loaded into the iterator
`numeric`	`last()` moves to the last record in the query
`numeric`	`length()` returns the size of the loaded query
`private any`	`loadRecord()` loads the active record object with the current query record
`boolean`	`more()` indicates if the query contains more records after the current record
`void`	`moveTo(numeric index)` moves to and loads a specified record in the query
`boolean`	`next()` moves to and loads the next record - returns true if there are more records

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(query query, any record)

Parameters:: query - a query from which the record object is loaded with data; record - an active record object to load when the index changes

Method Detail

back

public numeric back()

moves to and loads the previous record - stops at zero - returns the index

first

public numeric first()

moves to the first record

getIndex

public numeric getIndex()

returns the current index of the iterator

getQuery

public query getQuery()

returns the query loaded into the iterator

getRecord

public any getRecord()

returns the active record object loaded into the iterator

last

public numeric last()

moves to the last record in the query

length

public numeric length()

returns the size of the loaded query

loadRecord

private any loadRecord()

loads the active record object with the current query record

public boolean more()

indicates if the query contains more records after the current record

moveTo

public void moveTo(numeric index)

moves to and loads a specified record in the query

public boolean next()

moves to and loads the next record - returns true if there are more records

Overview

Package