|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.sun.mdm.index.page.PageIteratorWrapper
com.sun.mdm.index.master.search.enterprise.EOSearchResultIterator
The EOSearchResultIterator class represents an iterator containing the EOSearchResultRecord objects returned by a call to searchEnterpriseObject. Uses indexes to page through the EOSearchResultRecord objects and to retrieve specific objects from the iterator.
| Constructor Summary | |
EOSearchResultIterator(EOSearchResultRecord[] fullData)
Creates a new instance of the EOSearchResultIterator class that does not maintain the connection to the server. |
|
EOSearchResultIterator(PageData pageData,
int pageSize,
int maxElements)
Creates a new instance of the EOSearchResultIterator class that maintains the connection to the server. |
|
| Method Summary | |
EOSearchResultRecord |
absolute(int index)
Retrieves an EOSearchResultRecord object at the specified index from the EOSearchResultIterator object. |
EOSearchResultRecord[] |
absolute(int index,
int count)
Retrieves a series of rows from an EOSearchResultIterator object, beginning with the row at the specified index and continuing through the specified number of rows. |
EOSearchResultRecord |
first()
Retrieves the first row from an EOSearchResultIterator object. |
EOSearchResultRecord[] |
first(int count)
Retrieves the first rows in the iterator. |
EOSearchResultRecord |
next()
Retrieves the next row from an EOSearchResultIterator object. |
EOSearchResultRecord[] |
next(int count)
Retrieves the next series of rows in the iterator. |
EOSearchResultRecord |
prev()
Retrieves the previous row from an EOSearchResultIterator object. |
EOSearchResultRecord[] |
prev(int count)
Retrieves the previous series of rows in the iterator. |
void |
sortBy(java.lang.String field,
boolean reverse)
Sorts the objects in the EOSearchResultIterator by the specified comparator. |
| Methods inherited from class com.sun.mdm.index.page.PageIteratorWrapper |
close, count, currentPosition, getGenericIterator, hasNext |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public EOSearchResultIterator(EOSearchResultRecord[] fullData)
throws PageException
fullData - An array of all objects in the result set.
PageException - Thrown if an error occurs while creating
the iterator.
public EOSearchResultIterator(PageData pageData,
int pageSize,
int maxElements)
throws PageException
pageData - A session bean that stores the data retrieved from
the server.pageSize - The size of each unit of data retrieved from the
server.maxElements - The maximum number of elements retrieved for an
enterprise object search.
PageException - An error occurred while creating
the iterator.| Method Detail |
public EOSearchResultRecord absolute(int index)
throws PageException,
java.rmi.RemoteException
index - The row to retrieve.
EOSearchResultRecord - An
EOSearchResultRecord object.
PageException - Thrown if an error occurs while
retrieving the object.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
public EOSearchResultRecord[] absolute(int index,
int count)
throws PageException,
java.rmi.RemoteException
index - The first row to retrieve.count - The total number of rows to retrieve.
EOSearchResultRecord[] - An array of
EOSearchResultRecord objects.
PageException - Thrown if an error occurs while
retrieving the objects.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
public EOSearchResultRecord first()
throws PageException,
java.rmi.RemoteException
EOSearchResultRecord - An
EOSearchResultRecord object.
PageException - Thrown if an error occurs while
retrieving the object.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
public EOSearchResultRecord[] first(int count)
throws PageException,
java.rmi.RemoteException
count - The total number of rows to retrieve.
EOSearchResultREcord[] - An array of
EOSearchResultREcord objects.
PageException - Thrown if an error occurs while
retrieving the objects.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
public EOSearchResultRecord next()
throws java.rmi.RemoteException,
PageException
EOSearchResultRecord - An
EOSearchResultRecord object.
PageException - Thrown if the call to hasNext
returns false.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
public EOSearchResultRecord[] next(int count)
throws java.rmi.RemoteException,
PageException
count - The total number of rows to retrieve.
EOSearchResultRecord[] - An array of
EOSearchResultRecord objects.
PageException - Thrown if the index is already
at the end of the iterator.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
public EOSearchResultRecord prev()
throws PageException,
java.rmi.RemoteException
EOSearchResultRecord - An EOSearchResultRecord
object.
PageException - Thrown if the index is already at the
beginning of the iterator.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
public EOSearchResultRecord[] prev(int count)
throws PageException,
java.rmi.RemoteException
count - The total number of rows to retrieve.
EOSearchResultRecord[] - An array of
EOSearchResultRecord objects.
PageException - Thrown if the index is
already at the beginning of the iterator.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
public void sortBy(java.lang.String field,
boolean reverse)
throws java.rmi.RemoteException,
PageException
field - The name of field to use as sorting criteria.reverse - An indicator of whether to sort in ascending or
descending order. Specify true to sort in descending
order, or specify false to sort in ascending order.
void - None.
PageException - Thrown if there is an error
during sorting.
java.rmi.RemoteException - Thrown if the connection to
the server goes down during processing.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Sun Microsystems, Inc.