org.LexGrid.LexBIG.Utility.Iterators
Interface EntityListIterator

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

public interface EntityListIterator
extends java.io.Serializable

Version:
1.0
Author:
Harold Solbrig

Method Summary
 boolean hasNext()
          True means that there still values that can be returned.
 int numberRemaining()
          Returns a count of the number of items remaining in the iterator.
 void release()
          Release the iterator.
 

Method Detail

hasNext

boolean hasNext()
                throws LBResourceUnavailableException
True means that there still values that can be returned. False means all values have already been returned. This method only applies to calls to next() and next(int) - it does not have any bearing on calls to get(int, int).

Throws:
LBResourceUnavailableException

release

void release()
             throws LBResourceUnavailableException
Release the iterator. Iterators can have a fixed lifespan as determined by the service, but this allows the iterator to be returned gracefully to the system.

Throws:
LBResourceUnavailableException

numberRemaining

int numberRemaining()
                    throws LBResourceUnavailableException
Returns a count of the number of items remaining in the iterator. This is optional, and may only be an estimate. Implementations should return -1 if they cannot count or estimate the number remaining. Note: This method is not affected by calls to get(int, int). It only returns counts with respect to calls to next() or next(int).

Throws:
LBResourceUnavailableException
See Also:
for an authoritative answer whether or not the iterator has returned all possible items.

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.