org.apache.jetspeed.portal.portlets.browser
Interface BrowserIterator

All Superinterfaces:

java.util.Comparator, java.util.Iterator, java.io.Serializable

All Known Implementing Classes:

DatabaseBrowserIterator

public interface BrowserIterator

extends java.util.Iterator, java.util.Comparator, java.io.Serializable

Browser Iterator Interface

Version:

$Id: BrowserIterator.java,v 1.7 2004/02/23 03:26:43 jford Exp $

Author:

David Sean Taylor

Method Summary

int	getBottom() This method returns the last index of the row in the window displayed.
java.util.List	getResultSet() This method returns the result set vector.
int	getResultSetSize() This method returns the number of rows in the result set.
java.util.List	getResultSetTitleList() This method returns the List containg the column labels of the result set.
java.util.List	getResultSetTypesList() This method returns the List containg the Types of the columns the result set.
int	getTop() This method returns the index of the row to which the cursor is pointing at.
int	getWindowSize() This method returns the window size.
void	setTop(int start) This method points the cursor to the index provided.
void	sort(java.lang.String sortColumnName) This method sorts the result set according to the value of the column as specified by the parameter column name.

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.util.Comparator

compare, equals

Method Detail

getTop

public int getTop()

This method returns the index of the row to which the cursor is pointing at.

getWindowSize

public int getWindowSize()

This method returns the window size.

getBottom

public int getBottom()

This method returns the last index of the row in the window displayed.

setTop

public void setTop(int start)

This method points the cursor to the index provided.

Parameters:

start - Index to which cursor should point to

getResultSet

public java.util.List getResultSet()

This method returns the result set vector.

getResultSetSize

public int getResultSetSize()

This method returns the number of rows in the result set.

getResultSetTitleList

public java.util.List getResultSetTitleList()

This method returns the List containg the column labels of the result set.

getResultSetTypesList

public java.util.List getResultSetTypesList()

This method returns the List containg the Types of the columns the result set.

See Also:

Types

sort

public void sort(java.lang.String sortColumnName)

This method sorts the result set according to the value of the column as specified by the parameter column name. Changes the order of the result set vector. If it is called on the same columnName more than once it toggles the ordering ie first it will be ascending, then it will be descending, then ascending and so on.