|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResolvedConceptReferencesIterator
An iterator for retrieving Resolved coding scheme references
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 |
---|
ResolvedConceptReference next() throws LBResourceUnavailableException, LBInvocationException
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).
LBResourceUnavailableException
LBInvocationException
ResolvedConceptReferenceList next(int maxToReturn) throws LBResourceUnavailableException, LBInvocationException
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".
LBResourceUnavailableException
LBInvocationException
ResolvedConceptReferenceList get(int start, int end) throws LBResourceUnavailableException, LBInvocationException, LBParameterException
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)
LBResourceUnavailableException
LBInvocationException
LBParameterException
ResolvedConceptReferencesIterator scroll(int maxToReturn) throws LBResourceUnavailableException, LBInvocationException
maxToReturn
- The maximum number of remaining concepts to return
LBResourceUnavailableException
LBInvocationException
ResolvedConceptReferenceList getNext()
|
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |