org.LexGrid.LexBIG.Utility.Iterators
Interface ResolvedConceptReferencesIterator

All Superinterfaces:
EntityListIterator, java.io.Serializable
All Known Implementing Classes:
IteratorBackedResolvedConceptReferencesIterator, ResolvedConceptReferencesIteratorAdapter, ResolvedConceptReferencesIteratorImpl, ScoredIterator, ToNodeListResolvedConceptReferencesIteratorDecorator

public interface ResolvedConceptReferencesIterator
extends EntityListIterator

An iterator for retrieving Resolved coding scheme references

Version:
1.0
Author:
solbrigcvs

Method Summary
 ResolvedConceptReferenceList get(int start, int end)
          Return concept references from the underlying list, from the start point (inclusive) to the end point (exclusive).
 ResolvedConceptReferenceList getNext()
          Return a list containing the items specified in the last scroll call.
 ResolvedConceptReference next()
          Return the next available concept reference, in order, from the underlying list.
 ResolvedConceptReferenceList next(int maxToReturn)
          Return concept references from the underlying list, in order and up to the specified maximum.
 ResolvedConceptReferencesIterator scroll(int maxToReturn)
          Return the next batch of resolved concept references.
 
Methods inherited from interface org.LexGrid.LexBIG.Utility.Iterators.EntityListIterator
hasNext, numberRemaining, release
 

Method Detail

next

ResolvedConceptReference next()
                              throws LBResourceUnavailableException,
                                     LBInvocationException
Return the next available concept reference, in order, from the underlying list.

Note: This is effectively the same as performing next(1), but eliminates the need to continually unwrap the concept reference from the resolved list. Note: This method is not affected by calls to get(int, int).

Throws:
LBResourceUnavailableException
LBInvocationException

next

ResolvedConceptReferenceList next(int maxToReturn)
                                  throws LBResourceUnavailableException,
                                         LBInvocationException
Return concept references from the underlying list, in order and up to the specified maximum. Note: This method is not affected by calls to get(int, int).

Parameters:
maxToReturn - The maximum number of entries to return. Note that the interface may return less than the supplied number of entries even if there are still more to come. -1 means return a "natural" block size, potentially up to the maximum amount available, as determined by the service software. 0 returns an empty list and can be used to keep the iterator "alive".
Throws:
LBResourceUnavailableException
LBInvocationException

get

ResolvedConceptReferenceList get(int start,
                                 int end)
                                 throws LBResourceUnavailableException,
                                        LBInvocationException,
                                        LBParameterException
Return concept references from the underlying list, from the start point (inclusive) to the end point (exclusive). Calling this method has no effect on the next() calls - next() will still iterate through the results in the same sequential order regardless of if this method has been used. the result of numberRemaining() is not affected by calls to this method. Note: This method may return fewer results than requested even if there are still more results after the last result returned by the service. Note: The method is optional, and may not be implemented by all implementations. Note: Using this method in combination with Filters may cause significant performance reductions.

Parameters:
start - The start point of the range of results to return - inclusive. The entries list is 0 indexed - so to get the first result, you should start with '0'. LBParameterException is thrown if the start position is > the last item available.
end - The end point of the range of results to return - exclusive. A range request of (0, 50) will return 50 items (0 through 49 in an array)
Throws:
LBResourceUnavailableException
LBInvocationException
LBParameterException

scroll

ResolvedConceptReferencesIterator scroll(int maxToReturn)
                                         throws LBResourceUnavailableException,
                                                LBInvocationException
Return the next batch of resolved concept references.

Parameters:
maxToReturn - The maximum number of remaining concepts to return
Returns:
Throws:
LBResourceUnavailableException
LBInvocationException

getNext

ResolvedConceptReferenceList getNext()
Return a list containing the items specified in the last scroll call.

Returns:

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.