abstractdocumentfactory.java

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

package it.unimi.dsi.mg4j.document;

/*		 
 * MG4J: Managing Gigabytes for Java
 *
 * Copyright (C) 2005-2007 Paolo Boldi and 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.lang.MutableString;

/** An abstract implementation of a factory, providing a protected method to check
 *  for field indices.
 */

public abstract class AbstractDocumentFactory implements DocumentFactory {
	private static final long serialVersionUID = 1L;

	/** Checks that the index is correct (between 0, inclusive, and {@link it.unimi.dsi.mg4j.document.DocumentFactory#numberOfFields()},
	 *  exclusive), and throws an {@link IndexOutOfBoundsException} if the index is not correct.
	 * 
	 * @param index the index to be checked.
	 */
	protected void ensureFieldIndex( final int index ) {
		if ( index < 0 || index >= numberOfFields() )
			throw new IndexOutOfBoundsException( Integer.toString( index ) ); 
	}

	public String toString() {
		final MutableString res = new MutableString().append( '[' );
		for ( int field = 0; field < numberOfFields(); field++ ) 
			res.append( ' ' ).append( fieldName( field ) ).append( ':' ).append( fieldType( field ).name() );
		return res.append( " ]" ).toString();
	}
}