|
|||||||||
| 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.potdup.PotentialDuplicateIterator
The PotentialDuplicateIterator class represents an iterator containing the PotentialDuplicateSummary objects returned by a call to lookupPotentialDuplicates. Use indexes to page through the PotentialDuplicateSummary objects and to retrieve specific objects from the iterator.
| Constructor Summary | |
PotentialDuplicateIterator(java.util.ArrayList fullData)
Creates a new instance of the PotentialDuplicateIterator class that does not maintain the connection to the server. |
|
PotentialDuplicateIterator(PageData pageData,
int pageSize,
int maxElements)
Creates a new instance of the PotentialDuplicateIterator class that maintains the connection to the server. |
|
| Method Summary | |
PotentialDuplicateSummary |
absolute(int index)
Retrieves a PotentialDuplicateSummary object at the specified index from the PotentialDuplicateIterator object. |
PotentialDuplicateSummary[] |
absolute(int index,
int count)
Retrieves a series of rows from a PotentialDuplicateIterator object, beginning with the row at the specified index and continuing through the specified number of rows. |
PotentialDuplicateSummary |
first()
Retrieves the first row from a PotentialDuplicateIterator object. |
PotentialDuplicateSummary[] |
first(int count)
Retrieves the first rows in the iterator. |
PotentialDuplicateSummary |
next()
Retrieves the next row from a PotentialDuplicateIterator object. |
PotentialDuplicateSummary[] |
next(int count)
Retrieves the next series of rows in the iterator. |
PotentialDuplicateSummary |
prev()
Retrieves the previous row from a PotentialDuplicateIterator object. |
PotentialDuplicateSummary[] |
prev(int count)
Retrieves the previous series of rows in the iterator. |
void |
setReadForwardOnly(boolean forwardOnly)
Specifies whether the potential duplicate 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 PotentialDuplicateIterator by the specified comparator. |
void |
sortSummaryBy(java.lang.String field,
boolean reverse)
Sorts the objects in the PotentialDuplicateIterator 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 PotentialDuplicateIterator(java.util.ArrayList fullData)
throws PageException
fullData - An array of all objects in the result set.
PageException - Thrown if an error occurs while creating
the iterator.
public PotentialDuplicateIterator(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 a
potential duplicate search.
PageException - An error occurred while creating
the iterator.| Method Detail |
public PotentialDuplicateSummary absolute(int index)
throws PageException,
java.rmi.RemoteException
index - The row to retrieve.
PotentialDuplicateSummary - A
PotentialDuplicateSummary 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 PotentialDuplicateSummary[] absolute(int index,
int count)
throws PageException,
java.rmi.RemoteException
index - The first row to retrieve.count - The total number of rows to retrieve.
PotentialDuplicateSummary[] - An array of
PotentialDuplicateSummary 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 PotentialDuplicateSummary first()
throws PageException,
java.rmi.RemoteException
PotentialDuplicateSummary - A
PotentialDuplicateSummary 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 PotentialDuplicateSummary[] first(int count)
throws PageException,
java.rmi.RemoteException
count - The total number of rows to retrieve.
PotentialDuplicateSummary[] - An array of
PotentialDuplicateSummary 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 PotentialDuplicateSummary next()
throws java.rmi.RemoteException,
PageException
PotentialDuplicateSummary - A
PotentialDuplicateSummary 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 PotentialDuplicateSummary[] next(int count)
throws java.rmi.RemoteException,
PageException
count - The total number of rows to retrieve.
PotentialDuplicateSummary[] - An array of
PotentialDuplicateSummary 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 PotentialDuplicateSummary prev()
throws PageException,
java.rmi.RemoteException
PotentialDuplicateSummary - A
PotentialDuplicateSummary 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 PotentialDuplicateSummary[] prev(int count)
throws PageException,
java.rmi.RemoteException
count - The total number of rows to retrieve.
PotentialDuplicateSummary[] - An array of
PotentialDuplicateSummary 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 | ||||||||
Sun Microsystems, Inc.