|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.stc.eindex.page.PageIteratorWrapper com.stc.eindex.master.search.audit.AuditIterator
The AuditIterator class represents an iterator containing the AuditDataObject objects returned by a call to lookupAuditLog. Use indexes to page through the AuditDataObject objects and to retrieve specific objects from the iterator.
Constructor Summary | |
AuditIterator(java.util.ArrayList fullData)
Creates a new instance of the AuditIterator class that does not maintain the connection to the server. |
|
AuditIterator(PageData pageData,
int pageSize,
int maxElements)
Creates a new instance of the AuditIterator class that maintains the connection to the server. |
Method Summary | |
AuditDataObject |
absolute(int index)
Retrieves an audit data object (class AuditDataObject) at the specified index from the AuditIterator object. |
AuditDataObject[] |
absolute(int index,
int count)
Retrieves a series of rows from an AuditIterator object, beginning with the row at the specified index and continuing through the specified number of rows. |
AuditDataObject |
first()
Retrieves the first row from an AuditIterator object. |
AuditDataObject[] |
first(int count)
Retrieves the first rows in the iterator. |
AuditDataObject |
next()
Retrieves the next row from an AuditIterator object. |
AuditDataObject[] |
next(int count)
Retrieves the next series of rows in the iterator. |
AuditDataObject |
prev()
Retrieves the previous row from an AuditIterator object. |
AuditDataObject[] |
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 AuditIterator by the specified comparator. |
Methods inherited from class com.stc.eindex.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 AuditIterator(java.util.ArrayList fullData)
fullData
- An array of all objects in the result set.
public AuditIterator(PageData pageData, int pageSize, int maxElements)
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
audit log search.
Method Detail |
public AuditDataObject absolute(int index) throws PageException, java.rmi.RemoteException
index
- The row to retrieve.
AuditDataObject
- An audit data 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 AuditDataObject[] absolute(int index, int count) throws PageException, java.rmi.RemoteException
index
- The first row to retrieve.count
- The total number of rows to retrieve.
AuditDataObject[]
- An array of audit data
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 AuditDataObject first() throws PageException, java.rmi.RemoteException
AuditDataObject
- An audit data 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 AuditDataObject[] first(int count) throws PageException, java.rmi.RemoteException
count
- The total number of rows to retrieve.
AuditDataObject[]
- An array of audit data
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 AuditDataObject next() throws java.rmi.RemoteException, PageException
AuditDataObject
- An audit data
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 AuditDataObject[] next(int count) throws java.rmi.RemoteException, PageException
count
- The total number of rows to retrieve.
AuditDataObject[]
- An array of audit data
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 AuditDataObject prev() throws PageException, java.rmi.RemoteException
AuditDataObject
- An audit data
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 AuditDataObject[] prev(int count) throws PageException, java.rmi.RemoteException
count
- The total number of rows to retrieve.
AuditDataObject[]
- An array of
audit data 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 PageException, java.rmi.RemoteException
field
- The name of the 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 |
Copyright 2007 by Sun Microsystems, Inc. All Rights Reserved.