termmaps.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) 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 it.unimi.dsi.mg4j.search.Interval;
import it.unimi.dsi.util.StringMap;
import it.unimi.dsi.mg4j.util.MutableString;

import java.io.Serializable;

/** A class providing static methods and objects that do useful things with 
 * {@linkplain TermMap term maps} and {@linkplain PrefixMap prefix maps}.
 * 
 * @see TermMap
 * @see PrefixMap
 * @author Sebastiano Vigna
 * @deprecated Use {@link StringMap} and related classes.
 */

@Deprecated
public class TermMaps {
	private TermMaps() {}
	
	protected static class SynchronizedTermMap implements TermMap, Serializable {
		private static final long serialVersionUID = 1L;
		protected final TermMap termMap;

		public  SynchronizedTermMap( final TermMap termMap ) {
			this.termMap = termMap;
		}

		public synchronized int size() {
			return termMap.size();
		}

		public synchronized int getNumber( CharSequence term ) {
			return termMap.getNumber( term );
		}	

		public synchronized MutableString getTerm( int index, MutableString term ) {
			return termMap.getTerm( index, term );
		}

		public synchronized CharSequence getTerm( int index ) {
			return termMap.getTerm( index );
		}

		public boolean hasTerms() {
			return termMap.hasTerms();
		}
	}
	
	protected static class SynchronizedPrefixMap implements PrefixMap, Serializable {
		private static final long serialVersionUID = 1L;
		protected final PrefixMap prefixMap;

		public  SynchronizedPrefixMap( final PrefixMap prefixMap ) {
			this.prefixMap = prefixMap;
		}

		public synchronized Interval getInterval( CharSequence prefix ) {
			return prefixMap.getInterval( prefix );
		}

		public synchronized MutableString getPrefix( Interval interval, MutableString prefix ) {
			return prefixMap.getPrefix( interval, prefix );
		}

		public synchronized CharSequence getPrefix( Interval interval ) {
			return prefixMap.getPrefix( interval );
		}

		public synchronized int size() {
			return prefixMap.size();
		}

		public boolean hasPrefixes() {
			return prefixMap.hasPrefixes();
		}
	}

	protected static class SynchronizedTermPrefixMap extends SynchronizedTermMap implements PrefixMap {
		private static final long serialVersionUID = 1L;
		private final PrefixMap prefixMap;

		public SynchronizedTermPrefixMap( final Object termPrefixMap ) {
			super( (TermMap)termPrefixMap );
			this.prefixMap = (PrefixMap)termPrefixMap;
		}

		public synchronized Interval getInterval( CharSequence prefix ) {
			return prefixMap.getInterval( prefix );
		}

		public synchronized MutableString getPrefix( Interval interval, MutableString prefix ) {
			return prefixMap.getPrefix( interval, prefix );
		}

		public synchronized CharSequence getPrefix( Interval interval ) {
			return prefixMap.getPrefix( interval );
		}

		public boolean hasPrefixes() {
			return prefixMap.hasPrefixes();
		}
	}

	
    /** Returns a synchronized term map backed by the given term map.
     *
     * <p>If the provided term map implements also {@link PrefixMap},
     * the synchronized view will, too.
     *
     * @param termMap the term map to be wrapped in a synchronized map.
     * @return a synchronized view of the specified term map.
     */
	public static TermMap synchronize( final TermMap termMap ) {
		if ( termMap instanceof PrefixMap ) return new SynchronizedTermPrefixMap( termMap );
		return new SynchronizedTermMap( termMap );
	}

    /** Returns a synchronized prefix map backed by the given prefix map.
     * 
     * <p>If the provided prefix map implements also {@link TermMap},
     * the synchronized view will, too.
     *
     * @param prefixMap the prefix map to be wrapped in a synchronized map.
     * @return a synchronized view of the specified prefix map.
     */
	public static PrefixMap synchronize( final PrefixMap prefixMap ) {
		if ( prefixMap instanceof TermMap ) return new SynchronizedTermPrefixMap( prefixMap );
		return new SynchronizedPrefixMap( prefixMap );
	}
}