it.unimi.di.mg4j.index
Class InMemoryIndex

java.lang.Object
  it.unimi.di.mg4j.index.Index
      it.unimi.di.mg4j.index.BitStreamIndex
          it.unimi.di.mg4j.index.InMemoryIndex

All Implemented Interfaces:

Serializable

public class InMemoryIndex
extends BitStreamIndex

A local bitstream index loaded in memory.

In-memory indices are created by loading into main memory an index.

Since:

1.1

Author:

Sebastiano Vigna

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.di.mg4j.index.BitStreamIndex

BitStreamIndex.PropertyKeys

Nested classes/interfaces inherited from class it.unimi.di.mg4j.index.Index

Index.EmptyIndexIterator, Index.UriKeys

Field Summary

protected byte[]

index The byte array containing the index.

Fields inherited from class it.unimi.di.mg4j.index.BitStreamIndex

bufferSize, countCoding, DEFAULT_BUFFER_SIZE, DEFAULT_FIXED_QUANTUM, DEFAULT_HEIGHT, DEFAULT_QUANTUM, FIXED_POINT_BITS, FIXED_POINT_MULTIPLIER, frequencyCoding, height, offsets, pointerCoding, positionCoding, quantum, readerConstructor

Fields inherited from class it.unimi.di.mg4j.index.Index

field, hasCounts, hasPayloads, hasPositions, keyIndex, maxCount, numberOfDocuments, numberOfOccurrences, numberOfPostings, numberOfTerms, payload, prefixMap, properties, singletonSet, sizes, termMap, termProcessor

Constructor Summary

InMemoryIndex(byte[] index, int numberOfDocuments, int numberOfTerms, long numberOfPostings, long numberOfOccurrences, int maxCount, Payload payload, CompressionFlags.Coding frequencyCoding, CompressionFlags.Coding pointerCoding, CompressionFlags.Coding countCoding, CompressionFlags.Coding positionCoding, int quantum, int height, TermProcessor termProcessor, String field, Properties properties, StringMap<? extends CharSequence> termMap, PrefixMap<? extends CharSequence> prefixMap, IntList sizes, LongList offsets)

Method Summary

InputBitStream	getInputBitStream(int bufferSizeUnused) Returns an input bit stream over the index.
InputStream	getInputStream() Returns an input stream over the index.
String	toString()

Methods inherited from class it.unimi.di.mg4j.index.BitStreamIndex

featureName, gaussianGolombModulus, getConstructor, getReader, golombModulus, quantumSigma

Methods inherited from class it.unimi.di.mg4j.index.Index

documents, documents, documents, getEmptyIndexIterator, getEmptyIndexIterator, getEmptyIndexIterator, getEmptyIndexIterator, getInstance, getInstance, getInstance, getInstance, getInstance, getReader, getTermProcessor, keyIndex

Methods inherited from class java.lang.Object

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

Field Detail

index

protected final byte[] index

The byte array containing the index.

Constructor Detail

InMemoryIndex

public InMemoryIndex(byte[] index,
                     int numberOfDocuments,
                     int numberOfTerms,
                     long numberOfPostings,
                     long numberOfOccurrences,
                     int maxCount,
                     Payload payload,
                     CompressionFlags.Coding frequencyCoding,
                     CompressionFlags.Coding pointerCoding,
                     CompressionFlags.Coding countCoding,
                     CompressionFlags.Coding positionCoding,
                     int quantum,
                     int height,
                     TermProcessor termProcessor,
                     String field,
                     Properties properties,
                     StringMap<? extends CharSequence> termMap,
                     PrefixMap<? extends CharSequence> prefixMap,
                     IntList sizes,
                     LongList offsets)

Method Detail

toString

public String toString()

Overrides:

toString in class BitStreamIndex

getInputBitStream

public InputBitStream getInputBitStream(int bufferSizeUnused)

Description copied from class: BitStreamIndex

Returns an input bit stream over the index.

Specified by:

getInputBitStream in class BitStreamIndex

Parameters:

bufferSizeUnused - a suggested buffer size.

Returns:

an input bit stream over the index.

getInputStream

public InputStream getInputStream()

Description copied from class: BitStreamIndex

Returns an input stream over the index.

Specified by:

getInputStream in class BitStreamIndex

Returns:

an input stream over the index.