org.apache.portals.gems.browser
Interface BrowserIterator

All Superinterfaces:
java.util.Comparator, java.util.Iterator, java.io.Serializable
All Known Implementing Classes:
DatabaseBrowserIterator, PortletIterator

public interface BrowserIterator
extends java.util.Iterator, java.util.Comparator, java.io.Serializable

DatabaseBrowserPortlet

Version:
$Id: BrowserIterator.java 516448 2007-03-09 16:25:47Z ate $
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

int getTop()
This method returns the index of the row to which the cursor is pointing at.


getWindowSize

int getWindowSize()
This method returns the window size.


getBottom

int getBottom()
This method returns the last index of the row in the window displayed.


setTop

void setTop(int start)
This method points the cursor to the index provided.

Parameters:
start - Index to which cursor should point to

getResultSet

java.util.List getResultSet()
This method returns the result set vector.


getResultSetSize

int getResultSetSize()
This method returns the number of rows in the result set.


getResultSetTitleList

java.util.List getResultSetTitleList()
This method returns the List containg the column labels of the result set.


getResultSetTypesList

java.util.List getResultSetTypesList()
This method returns the List containg the Types of the columns the result set.

See Also:
Types

sort

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.

Parameters:
String - sortColumnName


Copyright © 1999-2010 Apache Software Foundation. All Rights Reserved.