linewordreader.java

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

package it.unimi.dsi.mg4j.io;

/*		 
 * 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.util.MutableString;

import java.io.IOException;
import java.io.Reader;
import java.io.Serializable;

/** A trivial {@link it.unimi.dsi.mg4j.io.WordReader} that considers each line
 * of a document a single word.
 * 
 * <p>The intended usage of this class is that of indexing stuff like lists of document
 * identifiers: if the identifiers contain nonalphabetical characters, the default
 * {@link it.unimi.dsi.mg4j.io.FastBufferedReader} might do a poor job. By setting
 * the {@link it.unimi.dsi.mg4j.document.PropertyBasedDocumentFactory.MetadataKeys#WORDREADER}
 * property, {@link it.unimi.dsi.mg4j.document.IdentityDocumentFactory} can use
 * this class as a word reader.
 * 
 * <p>Note that the non-word returned by {@link #next(MutableString, MutableString)} is
 * always empty.
 * @deprecated Moved to <code>dsiutils</code>.
 */

@Deprecated
public class LineWordReader implements WordReader, Serializable {
	private static final long serialVersionUID = 1L;
	/** An fast buffered reader wrapping the underlying reader. */
	private FastBufferedReader fastBufferedReader = new FastBufferedReader();

	public boolean next( final MutableString word, final MutableString nonWord ) throws IOException {
		nonWord.length( 0 );
		return fastBufferedReader.readLine( word ) != null;
	}
	
	public LineWordReader setReader( final Reader reader ) {
		fastBufferedReader.setReader( reader );
		return this;
	}
	
	public LineWordReader copy() {
		return new LineWordReader();
	}
}