org.terrier.terms.DumpTerm Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of terrier-core Show documentation
The newest version!
/*
 * Terrier - Terabyte Retriever 
 * Webpage: http://terrier.org 
 * Contact: terrier{a.}dcs.gla.ac.uk
 * University of Glasgow - School of Computing Science
 * http://www.gla.ac.uk/
 * 
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is DumpTerm.java.
 *
 * The Original Code is Copyright (C) 2004-2020 the University of Glasgow.
 * All Rights Reserved.
 *
 * Contributor(s):
 *  Gianni Amati  (original author)
 *  Craig Macdonald    
 */
package org.terrier.terms;

/** Useful development phase TermPipeline object that allows 
  * prints every term that passes through it to System.err
  */
public class DumpTerm implements TermPipeline {
	TermPipeline next = null;
	
	/** Construct a new DumpTerm objecy */
	public DumpTerm(TermPipeline _next)
	{
		this.next = _next;
	}
	
	/**
	 * Displays the given on STDERR, then passes onto next pipeline object.
	 * @param t String the term to pass onto next pipeline object
	 */
	public void processTerm(String t)
	{
		if (t == null)
			return;
		System.err.println("term: "+t);
		next.processTerm(t);
	}

	/**
	 * Implements the  default operation for all TermPipeline subclasses;
	 * By default do nothing.
	 * This method should be overrided by any TermPipeline that want to implements doc/query
	 * oriented lifecycle.
	 * @return return how the reset has gone
	 */
	public boolean reset() {
		return next!=null ? next.reset() : true;
	}
}