org.terrier.indexing

Class CollectionDocumentList

java.lang.Object

org.terrier.indexing.CollectionDocumentList

All Implemented Interfaces:

Closeable, AutoCloseable, Collection

public class CollectionDocumentList
extends Object
implements Collection

Constructor Summary

Constructors

Constructor and Description
CollectionDocumentList(Document[] _docs, String _docidPropertyName)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	endOfCollection() Returns true if the end of the collection has been reached
String	getDocid()
Document	getDocument() Get the document object representing the current document.
boolean	nextDocument() Move the collection to the start of the next document.
void	reset() Resets the Collection iterator to the start of the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionDocumentList

public CollectionDocumentList(Document[] _docs,
                              String _docidPropertyName)

Method Detail

endOfCollection

public boolean endOfCollection()

Description copied from interface: Collection

Returns true if the end of the collection has been reached

Specified by:

endOfCollection in interface Collection

Returns:

boolean true if the end of collection has been reached, otherwise it returns false.

getDocid

public String getDocid()

getDocument

public Document getDocument()

Description copied from interface: Collection

Get the document object representing the current document.

Specified by:

getDocument in interface Collection

Returns:

Document the current document;

nextDocument

public boolean nextDocument()

Description copied from interface: Collection

Move the collection to the start of the next document.

Specified by:

nextDocument in interface Collection

Returns:

boolean true if there exists another document in the collection, otherwise it returns false.

reset

public void reset()

Description copied from interface: Collection

Resets the Collection iterator to the start of the collection.

Specified by:

reset in interface Collection

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException