identitydocumentalstrategy.java

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

package it.unimi.dsi.mg4j.index.cluster;

/*		 
 * MG4J: Managing Gigabytes for Java
 *
 * Copyright (C) 2006-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 java.io.Serializable;

/** A documental strategy that maps identically local to global pointers and viceversa.
 * 
 * <p>When clustering <i>a posteriory</i> a set of previously built renumbered indices 
 * using a {@link it.unimi.dsi.mg4j.index.cluster.DocumentalMergedCluster}, 
 * local document pointers are actually global document pointers. 
 * In this case, an instance of this class should be used as a strategy
 * for the cluster.
 * 
 * @author Sebastiano Vigna
 */

public class IdentityDocumentalStrategy implements DocumentalClusteringStrategy, Serializable {

	private static final long serialVersionUID = 0L;

	/** The number of local indices. */
	private final int numberOfLocalIndices;
	/** The number of documents. */
	private final int numberOfDocuments;

	/** Creates a new identity documental clustering strategy.
	 * 
	 * @param numberOfLocalIndices the number of local indices.
	 * @param numberOfDocuments the number of documents.
	 */
	
	public IdentityDocumentalStrategy( final int numberOfLocalIndices, final int numberOfDocuments ) {
		this.numberOfLocalIndices = numberOfLocalIndices;
		this.numberOfDocuments = numberOfDocuments;
	}	
	
	public int numberOfLocalIndices() {
		return numberOfLocalIndices;
	}

	public int localPointer( final int globalPointer ) {
		return globalPointer;
	}

	public int globalPointer( final int localIndex, final int localPointer ) {
		return localPointer;		
	}

	public int numberOfDocuments( final int localIndex ) {
		return numberOfDocuments;
	}
	
	public String toString() {
		return this.getClass().getName() + "[local indices: " + numberOfLocalIndices + " documents: " + numberOfDocuments + "]";
	}
}