it.unipd.dei.ims.circo.indexing
Interface DocumentEmitter<D>

Type Parameters:

D - the actual type of document used by the information retrieval system.

All Superinterfaces:

java.lang.Iterable<D>, java.util.Iterator<D>

All Known Implementing Classes:

AbstractDocumentEmitter, BaseDocumentEmitter, CircoDocumentEmitter, LuceneDocumentEmitter

public interface DocumentEmitter<D>
extends java.lang.Iterable<D>, java.util.Iterator<D>

Parses a collection of Stream object serialized to XML and emits the contained document objects used by an information retrieval system.

Since:

0.10

Version:

0.10

Author:

Nicola Ferro

Method Summary

void	close() Closes the stream emitter.
java.lang.String	getIdentifier() Returns the unique identifier of the document emitter.
java.lang.String	getInputDirectory() Returns the directory where stream chunks are stored.
boolean	isCompressed() Checks whether the emitter is reading compressed the stream chunks.

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

getIdentifier

java.lang.String getIdentifier()

Returns the unique identifier of the document emitter.

Returns:

the unique identifier of the document emitter.

getInputDirectory

java.lang.String getInputDirectory()

Returns the directory where stream chunks are stored.

Returns:

the directory where stream chunks are stored.

isCompressed

boolean isCompressed()

Checks whether the emitter is reading compressed the stream chunks.

Returns:

true if he emitter is reading compressed the stream chunks; false otherwise.

close

void close()
           throws it.unipd.dei.ims.ici.component.ComponentException

Closes the stream emitter.

Throws:

it.unipd.dei.ims.ici.component.ComponentException - if something goes wrong while closing the stream emitter.