net.yacy.kelondro.rwi

Class ReferenceContainerArray<ReferenceType extends Reference>

java.lang.Object

net.yacy.kelondro.rwi.ReferenceContainerArray<ReferenceType>

public final class ReferenceContainerArray<ReferenceType extends Reference>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ReferenceContainerArray.BLOBReducer
static interface	ReferenceContainerArray.ContainerReducer<ReferenceType extends Reference>
class	ReferenceContainerArray.ReferenceContainerIterator
class	ReferenceContainerArray.ReferenceCountIterator

Field Summary

Fields

Modifier and Type	Field and Description
private ArrayStack	array
private ReferenceFactory<ReferenceType>	factory
private static long	METHOD_MAXRUNTIME

Constructor Summary

Constructors

Constructor and Description
ReferenceContainerArray(java.io.File heapLocation, java.lang.String prefix, ReferenceFactory<ReferenceType> factory, ByteOrder termOrder, int termSize) open a index container array based on BLOB dumps.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
void	close()
int	count(byte[] termHash)
void	delete(byte[] termHash) delete a indexContainer from the heap cache.
int	entries()
ReferenceContainer<ReferenceType>	get(byte[] termHash) get a indexContainer from a heap
boolean	has(byte[] termHash) test if a given key is in the heap this works with heaps in write- and read-mode
CloneableIterator<byte[]>	keys(boolean up, boolean rotating)
void	mountBLOBFile(java.io.File location)
java.io.File	newContainerBLOBFile()
ByteOrder	ordering()
int	reduce(byte[] termHash, ReferenceContainerArray.ContainerReducer<ReferenceType> reducer)
CloneableIterator<ReferenceContainer<ReferenceType>>	referenceContainerIterator(byte[] startWordHash, boolean rot, boolean excludePrivate) return an iterator object that creates top-level-clones of the indexContainers in the cache, so that manipulations of the iterated objects do not change objects in the cache.
CloneableIterator<Rating<byte[]>>	referenceCountIterator(byte[] startWordHash, boolean rot, boolean excludePrivate) return an iterator object that counts the number of references in indexContainers the startWordHash may be null to iterate all from the beginning
Row	rowdef()
boolean	shrinkAnySmallFiles(IODispatcher merger, long targetFileSize)
boolean	shrinkBestSmallFiles(IODispatcher merger, long targetFileSize)
boolean	shrinkOldFiles(IODispatcher merger)
boolean	shrinkUpToMaxSizeFiles(IODispatcher merger, long maxFileSize)
int[]	sizes()

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_MAXRUNTIME

private static final long METHOD_MAXRUNTIME

See Also:

Constant Field Values

factory

private final ReferenceFactory<ReferenceType extends Reference> factory

array

private final ArrayStack array

Constructor Detail

ReferenceContainerArray

public ReferenceContainerArray(java.io.File heapLocation,
                       java.lang.String prefix,
                       ReferenceFactory<ReferenceType> factory,
                       ByteOrder termOrder,
                       int termSize)
                        throws java.io.IOException

open a index container array based on BLOB dumps. The content of the BLOBs will not be read unless a .idx file exists. Only the .idx file is opened to get a fast read access to the BLOB. This class provides no write methods, because BLOB files should not be written in random access. To support deletion, a write access to the BLOB for deletion is still possible

Parameters:

payloadrow - the row definition for the BLOB data structure

log -

Throws:

java.io.IOException

Method Detail

close

public void close()

clear

public void clear()
           throws java.io.IOException

Throws:

java.io.IOException

sizes

public int[] sizes()

ordering

public ByteOrder ordering()

newContainerBLOBFile

public java.io.File newContainerBLOBFile()

mountBLOBFile

public void mountBLOBFile(java.io.File location)
                   throws java.io.IOException

Throws:

java.io.IOException

rowdef

public Row rowdef()

referenceContainerIterator

public CloneableIterator<ReferenceContainer<ReferenceType>> referenceContainerIterator(byte[] startWordHash,
                                                                              boolean rot,
                                                                              boolean excludePrivate)

return an iterator object that creates top-level-clones of the indexContainers in the cache, so that manipulations of the iterated objects do not change objects in the cache.

Throws:

java.io.IOException

referenceCountIterator

public CloneableIterator<Rating<byte[]>> referenceCountIterator(byte[] startWordHash,
                                                       boolean rot,
                                                       boolean excludePrivate)

return an iterator object that counts the number of references in indexContainers the startWordHash may be null to iterate all from the beginning

Throws:

java.io.IOException

has

public boolean has(byte[] termHash)

test if a given key is in the heap this works with heaps in write- and read-mode

Parameters:

key -

Returns:

true, if the key is used in the heap; false otherwise

Throws:

java.io.IOException

get

public ReferenceContainer<ReferenceType> get(byte[] termHash)
                                                        throws java.io.IOException,
                                                               SpaceExceededException

get a indexContainer from a heap

Parameters:

key -

Returns:

the indexContainer if one exist, null otherwise

Throws:

java.io.IOException

SpaceExceededException

count

public int count(byte[] termHash)
          throws java.io.IOException

Throws:

java.io.IOException

delete

public void delete(byte[] termHash)
            throws java.io.IOException

delete a indexContainer from the heap cache. This can only be used for write-enabled heaps

Parameters:

wordHash -

Throws:

java.io.IOException

reduce

public int reduce(byte[] termHash,
         ReferenceContainerArray.ContainerReducer<ReferenceType> reducer)
           throws java.io.IOException,
                  SpaceExceededException

Throws:

java.io.IOException

SpaceExceededException

keys

public CloneableIterator<byte[]> keys(boolean up,
                             boolean rotating)
                               throws java.io.IOException

Throws:

java.io.IOException

entries

public int entries()

shrinkBestSmallFiles

public boolean shrinkBestSmallFiles(IODispatcher merger,
                           long targetFileSize)

shrinkAnySmallFiles

public boolean shrinkAnySmallFiles(IODispatcher merger,
                          long targetFileSize)

shrinkUpToMaxSizeFiles

public boolean shrinkUpToMaxSizeFiles(IODispatcher merger,
                             long maxFileSize)

shrinkOldFiles

public boolean shrinkOldFiles(IODispatcher merger)