Package org.dspace.discovery

Class DiscoverResultItemIterator

java.lang.Object

org.dspace.discovery.DiscoverResultIterator<Item,UUID>

org.dspace.discovery.DiscoverResultItemIterator

All Implemented Interfaces:

Iterator<Item>

public class DiscoverResultItemIterator
extends DiscoverResultIterator<Item,UUID>

An iterator for discovering and iterating over DSpace items from the search index. This class extends DiscoverResultIterator and provides the logic to handle different types of indexable objects and retrieve the corresponding DSpace items.

It supports the following indexable object types:

• IndexableItem
• IndexableWorkflowItem
• IndexableWorkspaceItem
• IndexablePoolTask
• IndexableClaimedTask

Throws an IllegalStateException if the object type is not recognized.

Author:

Luca Giamminonni (luca.giamminonni at 4science.it)

Constructor Summary

Constructors

Constructor	Description
DiscoverResultItemIterator(Context context, DiscoverQuery discoverQuery)	Constructs an iterator for discovering items based on the given context and query.
DiscoverResultItemIterator(Context context, DiscoverQuery discoverQuery, boolean uncacheEntities)	Constructs an iterator with the option to uncache entities.
DiscoverResultItemIterator(Context context, DiscoverQuery discoverQuery, int maxResults)	Constructs an iterator with a limit on the maximum number of results.
DiscoverResultItemIterator(Context context, IndexableObject<?,?> scopeObject, DiscoverQuery discoverQuery)	Constructs an iterator within a specific scope object.
DiscoverResultItemIterator(Context context, IndexableObject<?,?> scopeObject, DiscoverQuery discoverQuery, int maxResults)	Constructs an iterator with a scope object and a limit on the maximum number of results.

Method Summary

Modifier and Type	Method	Description
Item	next()	Retrieves the next Item from the iterator.

Methods inherited from class org.dspace.discovery.DiscoverResultIterator

getNextIndexableObject, getTotalSearchResults, hasNext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Details

DiscoverResultItemIterator

public DiscoverResultItemIterator(Context context,
 DiscoverQuery discoverQuery)

Constructs an iterator for discovering items based on the given context and query.

Parameters:

context - the DSpace context

discoverQuery - the discovery query

DiscoverResultItemIterator

public DiscoverResultItemIterator(Context context,
 DiscoverQuery discoverQuery,
 boolean uncacheEntities)

Constructs an iterator with the option to uncache entities.

Parameters:

context - the DSpace context

discoverQuery - the discovery query

uncacheEntities - whether to uncache entities after iteration

DiscoverResultItemIterator

public DiscoverResultItemIterator(Context context,
 IndexableObject<?,?> scopeObject,
 DiscoverQuery discoverQuery)

Constructs an iterator within a specific scope object.

Parameters:

context - the DSpace context

scopeObject - the scope object

discoverQuery - the discovery query

DiscoverResultItemIterator

public DiscoverResultItemIterator(Context context,
 DiscoverQuery discoverQuery,
 int maxResults)

Constructs an iterator with a limit on the maximum number of results.

Parameters:

context - the DSpace context

discoverQuery - the discovery query

maxResults - the maximum number of results to return

DiscoverResultItemIterator

public DiscoverResultItemIterator(Context context,
 IndexableObject<?,?> scopeObject,
 DiscoverQuery discoverQuery,
 int maxResults)

Constructs an iterator with a scope object and a limit on the maximum number of results.

Parameters:

context - the DSpace context

scopeObject - the scope object

discoverQuery - the discovery query

maxResults - the maximum number of results to return

Method Details

next

public Item next()

Retrieves the next Item from the iterator. The item is obtained by determining the type of the next indexable object and extracting the corresponding item.

Specified by:

next in interface Iterator<Item>

Overrides:

next in class DiscoverResultIterator<Item,UUID>

Returns:

the next DSpace item

Throws:

IllegalStateException - if the object type is invalid