it.unipd.dei.ims.circo.indexing
Class CircoDocumentEmitter<D>

java.lang.Object
  it.unipd.dei.ims.circo.indexing.AbstractDocumentEmitter<D>
      it.unipd.dei.ims.circo.indexing.BaseDocumentEmitter<D>
          it.unipd.dei.ims.circo.indexing.CircoDocumentEmitter<D>

Type Parameters:

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LuceneDocumentEmitter

public abstract class CircoDocumentEmitter<D>
extends BaseDocumentEmitter<D>
implements DocumentEmitter<D>

Provides an implementation for the DocumentEmitter interface.

Since:

0.10

Version:

0.10

Author:

Nicola Ferro

Field Summary

Fields inherited from class it.unipd.dei.ims.circo.indexing.AbstractDocumentEmitter

logger

Constructor Summary

protected	CircoDocumentEmitter(java.io.File inputDirectory, boolean compressed) Creates a new document emitter.
protected	CircoDocumentEmitter(java.lang.String inputDirectory, boolean compressed) Creates a new document emitter.

Method Summary

void	close() Closes the stream emitter.
boolean	hasNext()
D	next()
protected abstract D	toDocument(Resource r) Maps a Resource to a document.

Methods inherited from class it.unipd.dei.ims.circo.indexing.BaseDocumentEmitter

endStreamChunk, getCurrentInputFile, getCurrentStreamChunk, getInputDirectory, hasNextResource, isCompressed, nextResource, startStreamChunk

Methods inherited from class it.unipd.dei.ims.circo.indexing.AbstractDocumentEmitter

equals, getIdentifier, hashCode, iterator, remove, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unipd.dei.ims.circo.indexing.DocumentEmitter

getIdentifier, getInputDirectory, isCompressed

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface java.util.Iterator

remove

Constructor Detail

CircoDocumentEmitter

protected CircoDocumentEmitter(java.io.File inputDirectory,
                               boolean compressed)

Creates a new document emitter.

Parameters:

inputDirectory - the directory where stream chunks are stored.

compressed - indicates whether the stream chunks are compressed or not.

CircoDocumentEmitter

protected CircoDocumentEmitter(java.lang.String inputDirectory,
                               boolean compressed)

Creates a new document emitter.

Parameters:

inputDirectory - the directory where stream chunks are stored.

compressed - indicates whether the stream chunks are compressed or not.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<D>

next

public final D next()

Specified by:

next in interface java.util.Iterator<D>

close

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

Description copied from interface: DocumentEmitter

Closes the stream emitter.

Specified by:

close in interface DocumentEmitter<D>

Throws:

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

toDocument

protected abstract D toDocument(Resource r)
                         throws it.unipd.dei.ims.ici.component.ComponentException

Maps a Resource to a document.

Parameters:

r - the resource to be mapped.

Returns:

the document corresponding to the given resource.

Throws:

it.unipd.dei.ims.ici.component.ComponentException - if something goes wrong while adding the document.