|
|||||||||
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.assumedmatch.AssumedMatchIterator
The AssumedMatchIterator class represents an iterator containing the AssumedMatchSummary objects returned by a call to lookupAssumedMatches. Use indexes to page through the AssumedMatchSummary objects and to retrieve specific objects from the iterator.
Constructor Summary | |
AssumedMatchIterator(java.util.ArrayList fullData)
Creates a new instance of the AssumedMatchIterator class that does not maintain the connection to the server. |
|
AssumedMatchIterator(PageData pageData,
int pageSize,
int maxElements)
Creates a new instance of the AssumedMatchIterator class that maintains the connection to the server. |
Method Summary | |
AssumedMatchSummary |
absolute(int index)
Retrieves an AssumedMatchSummary object at the specified index from the AssumedMatchIterator object. |
AssumedMatchSummary[] |
absolute(int index,
int count)
Retrieves a series of rows from an AssumedMatchIterator object, beginning with the row at the specified index and continuing through the specified number of rows. |
AssumedMatchSummary |
first()
Retrieves the first row from an AssumedMatchIterator object. |
AssumedMatchSummary[] |
first(int count)
Retrieves the first rows in the iterator. |
void |
maskData(SecurityAgent securityAgent)
Defines the security agent to use for hiding secure data from users who do not have the required access permissions. |
AssumedMatchSummary |
next()
Retrieves the next row from an AssumedMatchIterator object. |
AssumedMatchSummary[] |
next(int count)
Retrieves the next series of rows in the iterator. |
AssumedMatchSummary |
prev()
Retrieves the previous row from an AssumedMatchIterator object. |
AssumedMatchSummary[] |
prev(int count)
Retrieves the previous series of rows in the iterator. |
void |
setReadForwardOnly(boolean forwardOnly)
Specifies whether the assumed match iterator will clear all the DataPage objects of a loaded page (i) once it starts to read and load the next page (i+1). |
void |
sortBy(java.lang.String field,
boolean reverse)
Sorts the objects in the AssumedMatchIterator by the specified comparator. |
void |
sortSummaryBy(java.lang.String field,
boolean reverse)
Sorts the objects in the AssumedMatchIterator 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 AssumedMatchIterator(java.util.ArrayList fullData)
fullData
- An array of all objects in the result set.
public AssumedMatchIterator(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 assumed match search.
Method Detail |
public AssumedMatchSummary absolute(int index) throws PageException, java.rmi.RemoteException
index
- The row to retrieve.
AssumedMatchSummary
- An
AssumedMatchSummary 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 AssumedMatchSummary[] absolute(int index, int count) throws PageException, java.rmi.RemoteException
index
- The first row to retrieve.count
- The total number of rows to retrieve.
AssumedMatchSummary[]
- An array of
AssumedMatchSummary 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 AssumedMatchSummary first() throws PageException, java.rmi.RemoteException
AssumedMatchSummary
- An
AssumedMatchSummary 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 AssumedMatchSummary[] first(int count) throws PageException, java.rmi.RemoteException
count
- The total number of rows to retrieve.
AssumedMatchSummary[]
- An array of
AssumedMatchSummary 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 void maskData(SecurityAgent securityAgent)
securityAgent
- The security agent that masks the
data.
void
- None.
public AssumedMatchSummary next() throws java.rmi.RemoteException, PageException
AssumedMatchSummary
- An
AssumedMatchSummary 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 AssumedMatchSummary[] next(int count) throws java.rmi.RemoteException, PageException
count
- The total number of rows to retrieve.
AssumedMatchSummary[]
- An array of
AssumedMatchSummary 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 AssumedMatchSummary prev() throws PageException, java.rmi.RemoteException
AssumedMatchSummary
- An
AssumedMatchSummary 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 AssumedMatchSummary[] prev(int count) throws PageException, java.rmi.RemoteException
count
- The total number of rows to retrieve.
AssumedMatchSummary[]
- An array of
AssumedMatchSummary 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 setReadForwardOnly(boolean forwardOnly)
forwardOnly
- A Boolean indicator of whether the iterator will clear
old DataPage objects. Specify true to clear old DataPage objects;
specify false to leave the objects in memory.
void
- None.
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.public void sortSummaryBy(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.