org.imageterrier.locfile
Interface QLFCollection<F extends org.openimaj.feature.local.quantised.QuantisedLocalFeature<?>>

Type Parameters:

F - type of feature

All Superinterfaces:

Closeable, org.terrier.indexing.Collection

All Known Implementing Classes:

QLFFilesCollection, QLFInMemoryCollection, QLFSequenceFilesCollection

public interface QLFCollection<F extends org.openimaj.feature.local.quantised.QuantisedLocalFeature<?>>
extends org.terrier.indexing.Collection

A Collection of documents built from QuantisedLocalFeatures.

Author:

Jonathon Hare

Method Summary

int	getMaxNumIDChars() Get the maximum number of characters required to store the IDs of all the documents in this collection.
int	getMaxPathChars() Get the maximum number of characters required to store the path of each file in the collection

Methods inherited from interface org.terrier.indexing.Collection

endOfCollection, getDocid, getDocument, nextDocument, reset

Methods inherited from interface java.io.Closeable

close

Method Detail

getMaxNumIDChars

int getMaxNumIDChars()

Get the maximum number of characters required to store the IDs of all the documents in this collection. Assumes that the ID numbering is sequential from 1.

Returns:

the maximum number of id characters

getMaxPathChars

int getMaxPathChars()

Get the maximum number of characters required to store the path of each file in the collection

Returns:

the maximum number of path characters