com.stc.eindex.master.search.assumedmatch
Class AssumedMatchIterator

java.lang.Object
  com.stc.eindex.page.PageIteratorWrapper
      com.stc.eindex.master.search.assumedmatch.AssumedMatchIterator

All Implemented Interfaces:

java.io.Serializable

public class AssumedMatchIterator

extends PageIteratorWrapper

implements java.io.Serializable

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.

See Also:

Serialized Form

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

AssumedMatchIterator

public AssumedMatchIterator(java.util.ArrayList fullData)

Creates a new instance of the AssumedMatchIterator class that does not maintain the connection to the server.

Parameters:

fullData - An array of all objects in the result set.

Throws:

None.

AssumedMatchIterator

public AssumedMatchIterator(PageData pageData,
                            int pageSize,
                            int maxElements)

Creates a new instance of the AssumedMatchIterator class that maintains the connection to the server.

Parameters:

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.

Throws:

None.

Method Detail

absolute

public AssumedMatchSummary absolute(int index)
                             throws PageException,
                                    java.rmi.RemoteException

Retrieves an AssumedMatchSummary object at the specified index from the AssumedMatchIterator object.

Parameters:

index - The row to retrieve.

Returns:

AssumedMatchSummary - An AssumedMatchSummary object.

Throws:

PageException - Thrown if an error occurs while retrieving the object.

java.rmi.RemoteException - Thrown if the connection to the server goes down during processing.

absolute

public AssumedMatchSummary[] absolute(int index,
                                      int count)
                               throws PageException,
                                      java.rmi.RemoteException

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.

Parameters:

index - The first row to retrieve.

count - The total number of rows to retrieve.

Returns:

AssumedMatchSummary[] - An array of AssumedMatchSummary objects.

Throws:

PageException - Thrown if an error occurs while retrieving the objects.

java.rmi.RemoteException - Thrown if the connection to the server goes down during processing.

first

public AssumedMatchSummary first()
                          throws PageException,
                                 java.rmi.RemoteException

Retrieves the first row from an AssumedMatchIterator object.

Parameters:

None.

Returns:

AssumedMatchSummary - An AssumedMatchSummary object.

Throws:

PageException - Thrown if an error occurs while retrieving the object.

java.rmi.RemoteException - Thrown if the connection to the server goes down during processing.

first

public AssumedMatchSummary[] first(int count)
                            throws PageException,
                                   java.rmi.RemoteException

Retrieves the first rows in the iterator. The number of rows retrieved is specified as a parameter to this method. If the number of rows specified by the parameter is larger than the number of records in the iterator, all rows are retrieved.

Parameters:

count - The total number of rows to retrieve.

Returns:

AssumedMatchSummary[] - An array of AssumedMatchSummary objects.

Throws:

PageException - Thrown if an error occurs while retrieving the objects.

java.rmi.RemoteException - Thrown if the connection to the server goes down during processing.

maskData

public void maskData(SecurityAgent securityAgent)

Defines the security agent to use for hiding secure data from users who do not have the required access permissions.

Parameters:

securityAgent - The security agent that masks the data.

Returns:

void - None.

Throws:

None.

next

public AssumedMatchSummary next()
                         throws java.rmi.RemoteException,
                                PageException

Retrieves the next row from an AssumedMatchIterator object. If the current index is 4, this method returns the row at index=4.

Parameters:

None.

Returns:

AssumedMatchSummary - An AssumedMatchSummary object.

Throws:

PageException - Thrown if the call to hasNext returns false.

java.rmi.RemoteException - Thrown if the connection to the server goes down during processing.

next

public AssumedMatchSummary[] next(int count)
                           throws java.rmi.RemoteException,
                                  PageException

Retrieves the next series of rows in the iterator. The number of rows retrieved is specified as a parameter to this method. If the iterator does not have the specified number of rows remaining, it only retrieves the remaining rows.

Parameters:

count - The total number of rows to retrieve.

Returns:

AssumedMatchSummary[] - An array of AssumedMatchSummary objects.

Throws:

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.

prev

public AssumedMatchSummary prev()
                         throws PageException,
                                java.rmi.RemoteException

Retrieves the previous row from an AssumedMatchIterator object. If the current index is 5, this method returns the row at index=4 and leaves the position at index=4.

Parameters:

None.

Returns:

AssumedMatchSummary - An AssumedMatchSummary object.

Throws:

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.

prev

public AssumedMatchSummary[] prev(int count)
                           throws PageException,
                                  java.rmi.RemoteException

Retrieves the previous series of rows in the iterator. The number of rows retrieved is specified as a parameter to this method.

Parameters:

count - The total number of rows to retrieve.

Returns:

AssumedMatchSummary[] - An array of AssumedMatchSummary objects.

Throws:

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.

setReadForwardOnly

public 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). Setting the iterator to clear old DataPage objects helps to optimize the performance of assumed match searches and assumed match reports.

Parameters:

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.

Returns:

void - None.

Throws:

None.

sortBy

public void sortBy(java.lang.String field,
                   boolean reverse)
            throws PageException,
                   java.rmi.RemoteException

Sorts the objects in the AssumedMatchIterator by the specified comparator. This method loads the objects to be sorted.

Parameters:

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.

Returns:

void - None.

Throws:

PageException - Thrown if there is an error during sorting.

java.rmi.RemoteException - Thrown if the connection to the server goes down during processing.

sortSummaryBy

public void sortSummaryBy(java.lang.String field,
                          boolean reverse)
                   throws PageException,
                          java.rmi.RemoteException

Sorts the objects in the AssumedMatchIterator by the specified comparator. This method does not load the associated objects, improving the performance of the action.

Parameters:

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.

Returns:

void - None.

Throws:

PageException - Thrown if there is an error during sorting.

java.rmi.RemoteException - Thrown if the connection to the server goes down during processing.