com.ibm.lotus.search.providers.content.seedlist.common
Interface EntrySet

public interface EntrySet

Container for a set of entries (documents or seedlists). Each EntrySet can contain either only documents or both documents and seedlists.
The EntrySet interface contains properties of the retrieved entries for executed request. The EntrySet is represented by universal unique ID (UUID). The EntrySet contains metadata that represents common features for retrieved documents and seedlists, the number of returned entries (documents and seedlists), resulted crawling state for current crawling session and crawling state designed to next crawling session (incremental crawling).

Since:

Portal 6.0.1

Note:

This interface is designed to be implemented by clients.

Method Summary

java.util.Iterator	getDocuments() Returns an iterator to list of the available documents (Document).
java.lang.String	getId() Obtain universal unique Id (UUID) for the EntrySet
Metadata	getMetadata() Returns common features for retireved entries (documents and seedlists)
int	getNumberOfEntries() Returns the number of all found entries (both documents and seedlists) for this request
java.util.Iterator	getSeedlists() Returns an iterator to list of the available sub-seedlists (Seedlist).
State	getState() Returns the crawling state that may be used to optimize next crawling step on the same seedlist during the same crawling session
State	getTimestamp() Returns some snapshot of the content and allows to retrieve only the delta of content changes at the next crawling step on the same seedlist.

Method Detail

getId

java.lang.String getId()

Obtain universal unique Id (UUID) for the EntrySet

Returns:

universal unique Id (UUID) for the EntrySet

getMetadata

Metadata getMetadata()

Returns common features for retireved entries (documents and seedlists)

Returns:

common features for retireved entries (documents and seedlists)

getState

State getState()

Returns the crawling state that may be used to optimize next crawling step on the same seedlist during the same crawling session

Returns:

the current seedlist crawling state for the same crawling session

getTimestamp

State getTimestamp()

Returns some snapshot of the content and allows to retrieve only the delta of content changes at the next crawling step on the same seedlist. This is used for incremental crawling.

Returns:

seedlist crawling snapshot for the next crawling session

getNumberOfEntries

int getNumberOfEntries()

Returns the number of all found entries (both documents and seedlists) for this request

Returns:

the number of all found entries (both documents and seedlists) for this request

getDocuments

java.util.Iterator getDocuments()

Returns an iterator to list of the available documents (Document). This method never returns null. If there are no matching results, then the first next() call of Iterator will return null.

Returns:

an iterator to list of the available documents

getSeedlists

java.util.Iterator getSeedlists()

Returns an iterator to list of the available sub-seedlists (Seedlist). This method never returns null. If there are no matching results, then the first next() call of Iterator will return null.

Returns:

an iterator to list of the available sub-seedlists