anl.aida.client.doc
Interface DocumentContainer

All Known Subinterfaces:
CGEdge
All Known Implementing Classes:
DefaultCGEdge, TermNode

public interface DocumentContainer

Date: Mar 4, 2009 11:04:55 AM


Method Summary
 java.lang.Iterable<anl.aida.core.DocumentID> documents()
          Gets an iterable over the docs in this container.
 int getDocumentCount()
          Gets the number of documents in this container.
 void getDocuments(java.util.Collection<anl.aida.core.DocumentID> docs)
          Gets the documents contained by this container and puts them in the specified collection.
 

Method Detail

getDocumentCount

int getDocumentCount()
Gets the number of documents in this container.

Returns:
the number of documents in this container.

documents

java.lang.Iterable<anl.aida.core.DocumentID> documents()
Gets an iterable over the docs in this container.

Returns:
an iterable over the docs in this container.

getDocuments

void getDocuments(java.util.Collection<anl.aida.core.DocumentID> docs)
Gets the documents contained by this container and puts them in the specified collection.

Parameters:
docs - the collection to add the documents to