memorymappedhpindex.java

MG4J (Managing Gigabytes for Java) is a free full-text search engine for large document collections

package it.unimi.dsi.mg4j.index;

/*		 
 * MG4J: Managing Gigabytes for Java
 *
 * Copyright (C) 2007 Sebastiano Vigna 
 *
 *  This library is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU Lesser General Public License as published by the Free
 *  Software Foundation; either version 2.1 of the License, or (at your option)
 *  any later version.
 *
 *  This library is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 *  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

import it.unimi.dsi.fastutil.ints.IntList;
import it.unimi.dsi.fastutil.longs.LongList;
import it.unimi.dsi.mg4j.index.CompressionFlags.Coding;
import it.unimi.dsi.mg4j.index.payload.Payload;
import it.unimi.dsi.io.ByteBufferInputStream;
import it.unimi.dsi.io.InputBitStream;
import it.unimi.dsi.util.Properties;
import it.unimi.dsi.util.StringMap;
import it.unimi.dsi.util.PrefixMap;

import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;

/** A memory-mapped {@link BitStreamHPIndex}. See the discussion in {@link MemoryMappedIndex} (and consider
 * that since a high-performance index is actually split in two files, memory mapping is actually easier).
 *  
 * @author Sebastiano Vigna
 * @since 1.2
 */

public class MemoryMappedHPIndex extends BitStreamHPIndex {
	private static final long serialVersionUID = 0L;
	
	/** The byte buffer containing the index. */
	protected final ByteBuffer index;
	/** The byte buffer containing the positions. */
	protected final ByteBuffer positions;

	public MemoryMappedHPIndex( final ByteBuffer index, final ByteBuffer positions, final int numberOfDocuments, final int numberOfTerms, final long numberOfPostings,
			final long numberOfOccurrences, final int maxCount, final Payload payload, final Coding frequencyCoding, final Coding pointerCoding, final Coding countCoding, final Coding positionCoding, final int quantum, final int height, 
			final TermProcessor termProcessor, final String field, final Properties properties, final StringMap<? extends CharSequence> termMap, final PrefixMap<? extends CharSequence> prefixMap, final IntList sizes, final LongList offsets ) {
		super( numberOfDocuments, numberOfTerms, numberOfPostings, numberOfOccurrences, maxCount, payload, frequencyCoding, pointerCoding, countCoding, positionCoding, quantum, height, -1, termProcessor, field, properties, termMap, prefixMap, sizes, offsets );
		this.index = index;
		this.positions = positions;
	}

	@Override
	public InputBitStream getInputBitStream( int bufferSizeUnused ) {
		return new InputBitStream( getInputStream() );
	}
	
	@Override
	public ByteBufferInputStream getInputStream() {
		return new ByteBufferInputStream( (ByteBuffer)index.duplicate().position( 0 ) );
	}

	@Override
	public InputBitStream getPositionsInputBitStream( int bufferSizeUnused ) throws IOException {
		return new InputBitStream( getPositionsInputStream() );
	}

	@Override
	public InputStream getPositionsInputStream() throws IOException {
		return new ByteBufferInputStream( (ByteBuffer)positions.duplicate().position( 0 ) );
	}
}