iglu.ir
Interface DocumentSet

All Known Subinterfaces:

EditableDocumentSet

All Known Implementing Classes:

DefaultDocumentSet, PagedDocumentSet

public interface DocumentSet

An interface to a randomly accessible collection of documents. This is different from an InformationSource in that this is not queryable. Information is retrieved from here by referring to it by index.

This should maybe be descended from AbstractSequentialList but it isn't.

Indices should be 0-based

Author:

Method Summary

Document	getDoc(int docNum) Retrieve the document with the given index
java.lang.Object	getDocMeta(int docNum) Retrieve metadata for the indicated document.
java.util.Iterator	iterator() An iterator over the DocumentSet
void	setFilters(DocumentFilter[] filters) A set of filters which getDoc must apply when returning documents
int	size() The number of documents in the set

Method Detail

getDoc

public Document getDoc(int docNum)

Retrieve the document with the given index

getDocMeta

public java.lang.Object getDocMeta(int docNum)

Retrieve metadata for the indicated document. If no metadata is available, return a default message. This method should never return null as long as it it given a valid docNum.

iterator

public java.util.Iterator iterator()

An iterator over the DocumentSet

setFilters

public void setFilters(DocumentFilter[] filters)

A set of filters which getDoc must apply when returning documents

size

public int size()

The number of documents in the set