net.yacy.kelondro.rwi

Interface BufferedIndex<ReferenceType extends Reference>

All Superinterfaces:

Index<ReferenceType>, java.lang.Iterable<ReferenceContainer<ReferenceType>>

All Known Implementing Classes:

AbstractBufferedIndex, IndexCell

public interface BufferedIndex<ReferenceType extends Reference>
extends Index<ReferenceType>

Method Summary

Methods

Modifier and Type	Method and Description
long	getBufferMaxAge() return the date of the most recent buffer entry
int	getBufferMaxReferences() return the maximum number of references, that one buffer entry has stored
long	getBufferMinAge() return the date of the oldest buffer entry
int	getBufferSize() get the size of the buffer content
long	getBufferSizeBytes() calculate the memory that is taken by the buffer.
java.util.TreeSet<ReferenceContainer<ReferenceType>>	referenceContainer(byte[] startHash, boolean rot, boolean excludePrivate, int count, boolean buffer) collect reference container in index.
CloneableIterator<ReferenceContainer<ReferenceType>>	referenceContainerIterator(byte[] startHash, boolean rot, boolean excludePrivate, boolean buffer) iterate over entries in index.
void	setBufferMaxWordCount(int maxWords) set the size of the buffer, which can be defined with a given maximum number of words that shall be stored.

Methods inherited from interface net.yacy.kelondro.rwi.Index

add, add, clear, close, count, delete, get, has, merge, minMem, referenceContainerIterator, referenceCountIterator, referenceRow, remove, remove, remove, remove, removeDelayed, removeDelayed, searchConjunction, size, termKeyLength, termKeyOrdering

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

setBufferMaxWordCount

void setBufferMaxWordCount(int maxWords)

set the size of the buffer, which can be defined with a given maximum number of words that shall be stored. Because an arbitrary number of references can be stored at each word entry, this does not limit the memory that the buffer takes. It is possible to monitor the memory occupation of the buffer with the getBufferSizeBytes() method, and then adopt the buffer size with a new word number limit.

getBufferMaxReferences

int getBufferMaxReferences()

return the maximum number of references, that one buffer entry has stored

Returns:

getBufferMinAge

long getBufferMinAge()

return the date of the oldest buffer entry

Returns:

a time as milliseconds from epoch

getBufferMaxAge

long getBufferMaxAge()

return the date of the most recent buffer entry

Returns:

a time as milliseconds from epoch

getBufferSizeBytes

long getBufferSizeBytes()

calculate the memory that is taken by the buffer. This does not simply return a variable content. it is necessary to iterate over all entries to get the whole size. please use this method with great care

Returns:

number of bytes that the buffer has allocated

getBufferSize

int getBufferSize()

get the size of the buffer content

Returns:

number of word references

referenceContainerIterator

CloneableIterator<ReferenceContainer<ReferenceType>> referenceContainerIterator(byte[] startHash,
                                                                              boolean rot,
                                                                              boolean excludePrivate,
                                                                              boolean buffer)
                                                                                                  throws java.io.IOException

iterate over entries in index. this method differs from the iterator in an Index object in such a way that it has the additional 'buffer' flag. When using this method, the iteration goes only over the buffer content, or over the backend-content, but not over a merged content.

Parameters:

startHash -

rot -

buffer -

Returns:

Throws:

java.io.IOException

referenceContainer

java.util.TreeSet<ReferenceContainer<ReferenceType>> referenceContainer(byte[] startHash,
                                                                      boolean rot,
                                                                      boolean excludePrivate,
                                                                      int count,
                                                                      boolean buffer)
                                                                                          throws java.io.IOException

collect reference container in index. this method differs from the collector in an Index object in such a way that it has the additional 'buffer' flag. When using this method, the collection goes only over the buffer content, or over the backend-content, but not over a merged content.

Parameters:

startHash -

rot -

count -

buffer -

Returns:

Throws:

java.io.IOException