org.egothor.dockyard

Class StreamReader

java.lang.Object

org.egothor.dockyard.StreamReader

All Implemented Interfaces:

AutoCloseable, BarrelReader

public class StreamReader
extends Object
implements BarrelReader

StreamReader.java

Author:

galambos

Constructor Summary

Constructors

Constructor and Description
StreamReader(DataInput in)

Method Summary

Modifier and Type	Method and Description
void	close() Close this BarrelReader.
SequenceWithClose<DocumentData>	getDocuments() Returns an enumeration of all active documents.
SequenceWithClose<IListReader>	getILists() Returns an enumeration of all inverted lists.
long	length() Returns number of active documents in this Barrel.
void	rewind() Restart this BarrelReader so that the documents can be read again.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamReader

public StreamReader(DataInput in)
             throws IOException

Throws:

IOException

Method Detail

length

public long length()

Description copied from interface: BarrelReader

Returns number of active documents in this Barrel.

Specified by:

length in interface BarrelReader

Returns:

the number of active documents

rewind

public void rewind()
            throws IOException

Restart this BarrelReader so that the documents can be read again.

Specified by:

rewind in interface BarrelReader

Throws:

IOException

getILists

public SequenceWithClose<IListReader> getILists()

Description copied from interface: BarrelReader

Returns an enumeration of all inverted lists. The objects of the enumeration are IListReaders. The readers must be initialized and the reader can represent a free list, that is, an IListReader that has no items can be returned.

Specified by:

getILists in interface BarrelReader

Returns:

an Enumeration of IListReader objects

getDocuments

public SequenceWithClose<DocumentData> getDocuments()

Description copied from interface: BarrelReader

Returns an enumeration of all active documents. The objects of the enumeration are DocumentDatas. If the enumeration contains no elements, then the Barrel was destroyed completely.

Specified by:

getDocuments in interface BarrelReader

Returns:

an Enumeration of DocMDocumentDataects

close

public void close()

Description copied from interface: BarrelReader

Close this BarrelReader.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BarrelReader