public class ResolvedConceptReferencesIteratorImpl extends java.lang.Object implements ResolvedConceptReferencesIterator, java.lang.Cloneable
Modifier and Type | Class and Description |
---|---|
class |
ResolvedConceptReferencesIteratorImpl.CleanUpThread |
Constructor and Description |
---|
ResolvedConceptReferencesIteratorImpl() |
ResolvedConceptReferencesIteratorImpl(CodeHolder codes,
LocalNameList restrictToProperties,
CodedNodeSet.PropertyType[] restrictToPropertyTypes,
Filter[] filters,
boolean resolveEntities) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
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.
|
boolean |
hasNext()
True means that there still values that can be returned.
|
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.
|
int |
numberRemaining()
Returns a count of the number of items remaining in the iterator.
|
void |
release()
Release the iterator.
|
ResolvedConceptReferencesIterator |
scroll(int maxToReturn)
Return the next batch of resolved concept references.
|
public ResolvedConceptReferencesIteratorImpl()
public ResolvedConceptReferencesIteratorImpl(CodeHolder codes, LocalNameList restrictToProperties, CodedNodeSet.PropertyType[] restrictToPropertyTypes, Filter[] filters, boolean resolveEntities)
public ResolvedConceptReference next() throws LBResourceUnavailableException, LBInvocationException
ResolvedConceptReferencesIterator
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).
next
in interface ResolvedConceptReferencesIterator
LBResourceUnavailableException
LBInvocationException
public ResolvedConceptReferenceList next(int maxToReturn) throws LBResourceUnavailableException, LBInvocationException
ResolvedConceptReferencesIterator
next
in interface ResolvedConceptReferencesIterator
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
public ResolvedConceptReferenceList get(int start, int end) throws LBResourceUnavailableException, LBInvocationException, LBParameterException
ResolvedConceptReferencesIterator
get
in interface ResolvedConceptReferencesIterator
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
public boolean hasNext() throws LBResourceUnavailableException
EntityListIterator
hasNext
in interface EntityListIterator
LBResourceUnavailableException
public void release()
EntityListIterator
release
in interface EntityListIterator
public ResolvedConceptReferencesIterator scroll(int maxToReturn) throws LBResourceUnavailableException, LBInvocationException
ResolvedConceptReferencesIterator
scroll
in interface ResolvedConceptReferencesIterator
maxToReturn
- The maximum number of remaining concepts to returnLBResourceUnavailableException
LBInvocationException
public ResolvedConceptReferenceList getNext()
ResolvedConceptReferencesIterator
getNext
in interface ResolvedConceptReferencesIterator
public int numberRemaining() throws LBResourceUnavailableException
EntityListIterator
numberRemaining
in interface EntityListIterator
LBResourceUnavailableException
for an authoritative answer whether or not the iterator
has returned all possible items.
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException