net.yacy.kelondro.rwi

Class ReferenceContainer<ReferenceType extends Reference>

java.lang.Object

net.yacy.kelondro.index.RowCollection

net.yacy.kelondro.index.RowSet

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Row.Entry>, java.util.Comparator<Row.Entry>, Sortable<Row.Entry>, Index

public class ReferenceContainer<ReferenceType extends Reference>
extends RowSet

A ReferenceContainer is a set of ReferenceRows entries for a specific term. Since ReferenceRow entries are special Row entries, a collection of ReferenceRows can be contained in a RowSet. This class extends the RowSet with methods for the handling of special ReferenceRow Row entry objects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ReferenceContainer.entryIterator

Nested classes/interfaces inherited from class net.yacy.kelondro.index.RowSet

RowSet.keyIterator, RowSet.rowIterator

Nested classes/interfaces inherited from class net.yacy.kelondro.index.RowCollection

RowCollection.partitionthread

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.reflect.Method	containerMergeMethod
protected ReferenceFactory<ReferenceType>	factory
static int	maxReferences
private static long	serialVersionUID
private byte[]	termHash

Fields inherited from class net.yacy.kelondro.index.RowCollection

chunkcache, chunkcount, exportOverheadSize, growfactorLarge100, growfactorSmall100, lastTimeWrote, rowdef, sortBound

Constructor Summary

Constructors

Constructor and Description
ReferenceContainer(ReferenceFactory<ReferenceType> factory, byte[] termHash)
ReferenceContainer(ReferenceFactory<ReferenceType> factory, byte[] termHash, int objectCount)
ReferenceContainer(ReferenceFactory<ReferenceType> factory, byte[] termHash, RowSet collection)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Reference entry)
static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	emptyContainer(ReferenceFactory<ReferenceType> factory, byte[] termHash)
static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	emptyContainer(ReferenceFactory<ReferenceType> factory, byte[] termHash, int elementCount)
java.util.Iterator<ReferenceType>	entries()
static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	excludeContainers(ReferenceFactory<ReferenceType> factory, ReferenceContainer<ReferenceType> pivot, java.util.Collection<ReferenceContainer<ReferenceType>> containers)
static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	excludeDestructive(ReferenceFactory<ReferenceType> factory, ReferenceContainer<ReferenceType> pivot, ReferenceContainer<ReferenceType> excl)
private static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	excludeDestructiveByEnumeration(ReferenceFactory<ReferenceType> factory, ReferenceContainer<ReferenceType> pivot, ReferenceContainer<ReferenceType> excl)
private static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	excludeDestructiveByTest(ReferenceContainer<ReferenceType> pivot, ReferenceContainer<ReferenceType> excl)
ReferenceType	getReference(byte[] urlHash)
byte[]	getTermHash()
int	hashCode()
static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	joinConstructive(ReferenceFactory<ReferenceType> factory, ReferenceContainer<ReferenceType> i1, ReferenceContainer<ReferenceType> i2, int maxDistance)
private static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	joinConstructiveByEnumeration(ReferenceFactory<ReferenceType> factory, ReferenceContainer<ReferenceType> i1, ReferenceContainer<ReferenceType> i2, int maxDistance)
private static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	joinConstructiveByTest(ReferenceFactory<ReferenceType> factory, ReferenceContainer<ReferenceType> small, ReferenceContainer<ReferenceType> large, int maxDistance)
static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	joinContainers(ReferenceFactory<ReferenceType> factory, java.util.Collection<ReferenceContainer<ReferenceType>> containers, int maxDistance)
static <ReferenceType extends Reference> ReferenceContainer<ReferenceType>	joinExcludeContainers(ReferenceFactory<ReferenceType> factory, java.util.Collection<ReferenceContainer<ReferenceType>> includeContainers, java.util.Collection<ReferenceContainer<ReferenceType>> excludeContainers, int maxDistance)
private static int	log2(int x)
ReferenceContainer<ReferenceType>	merge(ReferenceContainer<ReferenceType> c)
static java.lang.Object	mergeUnique(java.lang.Object a, java.lang.Object b)
private int[]	oldPostions(int count)
private java.util.Collection<java.util.List<java.lang.Integer>>	positionsByLastMod()
void	put(Reference entry)
int	putAllRecent(ReferenceContainer<ReferenceType> c)
boolean	putRecent(Reference entry)
int	removeEntries(HandleSet urlHashes)
ReferenceType	removeReference(byte[] urlHash) remove a url reference from the container.
Reference	replace(Reference entry)
void	setWordHash(byte[] newTermHash)
int	shrinkReferences() Shrink the reference size in such a way that it does not exceed maxReferences In case that the index is too large, old entries are deleted
ReferenceContainer<ReferenceType>	topLevelClone()
java.lang.String	toString()
long	updated()

Methods inherited from class net.yacy.kelondro.index.RowSet

binaryPosition, clone, delete, delete, deleteOnExit, filename, get, get, has, importRowCount, importRowSet, inc, iterator, keys, keys, main, merge, mergeEnum, put, randomHash, randomHash, remove, replace, reset, rows, rows

Methods inherited from class net.yacy.kelondro.index.RowCollection

add, addAllUnique, addSorted, addUnique, addUnique, buffer, clear, close, compare, compare, delete, exportCollection, get, getKey, insertUnique, isEmpty, isSorted, keys, largestKey, lastWrote, match, match, mem, memoryNeededForGrow, optimize, random, removeDoubles, removeOne, removeRow, row, saveCollection, set, size, sizeOfExportedCollectionRows, smallestKey, sort, sorted, swap, test, top, trim, uniq

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addUnique, clear, close, isEmpty, largestKey, mem, optimize, random, removeDoubles, removeOne, row, size, smallestKey, top

Methods inherited from interface java.util.Comparator

equals

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

termHash

private byte[] termHash

factory

protected ReferenceFactory<ReferenceType extends Reference> factory

maxReferences

public static int maxReferences

containerMergeMethod

public static final java.lang.reflect.Method containerMergeMethod

Constructor Detail

ReferenceContainer

public ReferenceContainer(ReferenceFactory<ReferenceType> factory,
                  byte[] termHash,
                  RowSet collection)

ReferenceContainer

public ReferenceContainer(ReferenceFactory<ReferenceType> factory,
                  byte[] termHash)

ReferenceContainer

public ReferenceContainer(ReferenceFactory<ReferenceType> factory,
                  byte[] termHash,
                  int objectCount)
                   throws SpaceExceededException

Throws:

SpaceExceededException

Method Detail

topLevelClone

public ReferenceContainer<ReferenceType> topLevelClone()
                                                                  throws SpaceExceededException

Throws:

SpaceExceededException

emptyContainer

public static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> emptyContainer(ReferenceFactory<ReferenceType> factory,
                                                                                 byte[] termHash)

emptyContainer

public static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> emptyContainer(ReferenceFactory<ReferenceType> factory,
                                                                                 byte[] termHash,
                                                                                 int elementCount)
                                                                          throws SpaceExceededException

Throws:

SpaceExceededException

setWordHash

public void setWordHash(byte[] newTermHash)

updated

public long updated()

getTermHash

public byte[] getTermHash()

add

public void add(Reference entry)
         throws SpaceExceededException

Throws:

SpaceExceededException

merge

public ReferenceContainer<ReferenceType> merge(ReferenceContainer<ReferenceType> c)
                                                          throws SpaceExceededException

Throws:

SpaceExceededException

replace

public Reference replace(Reference entry)
                  throws SpaceExceededException

Throws:

SpaceExceededException

put

public void put(Reference entry)
         throws SpaceExceededException

Throws:

SpaceExceededException

putRecent

public boolean putRecent(Reference entry)
                  throws SpaceExceededException

Throws:

SpaceExceededException

putAllRecent

public int putAllRecent(ReferenceContainer<ReferenceType> c)
                 throws SpaceExceededException

Throws:

SpaceExceededException

getReference

public ReferenceType getReference(byte[] urlHash)

removeReference

public ReferenceType removeReference(byte[] urlHash)

remove a url reference from the container. if the url hash was found, return the entry, but delete the entry from the container if the entry was not found, return null.

removeEntries

public int removeEntries(HandleSet urlHashes)

shrinkReferences

public int shrinkReferences()

Shrink the reference size in such a way that it does not exceed maxReferences In case that the index is too large, old entries are deleted

Returns:

the number of deleted entries

oldPostions

private int[] oldPostions(int count)

positionsByLastMod

private java.util.Collection<java.util.List<java.lang.Integer>> positionsByLastMod()

entries

public java.util.Iterator<ReferenceType> entries()

mergeUnique

public static java.lang.Object mergeUnique(java.lang.Object a,
                           java.lang.Object b)
                                    throws SpaceExceededException

Throws:

SpaceExceededException

joinExcludeContainers

public static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> joinExcludeContainers(ReferenceFactory<ReferenceType> factory,
                                                                                        java.util.Collection<ReferenceContainer<ReferenceType>> includeContainers,
                                                                                        java.util.Collection<ReferenceContainer<ReferenceType>> excludeContainers,
                                                                                        int maxDistance)
                                                                                 throws SpaceExceededException

Throws:

SpaceExceededException

joinContainers

public static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> joinContainers(ReferenceFactory<ReferenceType> factory,
                                                                                 java.util.Collection<ReferenceContainer<ReferenceType>> containers,
                                                                                 int maxDistance)
                                                                          throws SpaceExceededException

Throws:

SpaceExceededException

excludeContainers

public static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> excludeContainers(ReferenceFactory<ReferenceType> factory,
                                                                                    ReferenceContainer<ReferenceType> pivot,
                                                                                    java.util.Collection<ReferenceContainer<ReferenceType>> containers)

log2

private static int log2(int x)

joinConstructive

public static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> joinConstructive(ReferenceFactory<ReferenceType> factory,
                                                                                   ReferenceContainer<ReferenceType> i1,
                                                                                   ReferenceContainer<ReferenceType> i2,
                                                                                   int maxDistance)
                                                                            throws SpaceExceededException

Throws:

SpaceExceededException

joinConstructiveByTest

private static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> joinConstructiveByTest(ReferenceFactory<ReferenceType> factory,
                                                                                         ReferenceContainer<ReferenceType> small,
                                                                                         ReferenceContainer<ReferenceType> large,
                                                                                         int maxDistance)
                                                                                   throws SpaceExceededException

Throws:

SpaceExceededException

joinConstructiveByEnumeration

private static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> joinConstructiveByEnumeration(ReferenceFactory<ReferenceType> factory,
                                                                                                ReferenceContainer<ReferenceType> i1,
                                                                                                ReferenceContainer<ReferenceType> i2,
                                                                                                int maxDistance)
                                                                                          throws SpaceExceededException

Throws:

SpaceExceededException

excludeDestructive

public static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> excludeDestructive(ReferenceFactory<ReferenceType> factory,
                                                                                     ReferenceContainer<ReferenceType> pivot,
                                                                                     ReferenceContainer<ReferenceType> excl)

excludeDestructiveByTest

private static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> excludeDestructiveByTest(ReferenceContainer<ReferenceType> pivot,
                                                                                           ReferenceContainer<ReferenceType> excl)

excludeDestructiveByEnumeration

private static <ReferenceType extends Reference> ReferenceContainer<ReferenceType> excludeDestructiveByEnumeration(ReferenceFactory<ReferenceType> factory,
                                                                                                  ReferenceContainer<ReferenceType> pivot,
                                                                                                  ReferenceContainer<ReferenceType> excl)

toString

public java.lang.String toString()

Overrides:

toString in class RowCollection

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object