JRQueryChunkHandler.java

/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2009 Jaspersoft Corporation. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports 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 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports 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 JasperReports. If not, see <http://www.gnu.org/licenses/>.
 */
package net.sf.jasperreports.engine.util;

/**
 * A query chunk handler.
 * 
 * @author Lucian Chirita (lucianc@users.sourceforge.net)
 * @version $Id: JRQueryChunkHandler.java 3034 2009-08-27 11:58:04Z teodord $
 * @see JRQueryParser#parse(String, JRQueryChunkHandler)
 */
public interface JRQueryChunkHandler
{

	/**
	 * Handle a plain text query chunk.
	 * 
	 * @param text the text
	 */
	void handleTextChunk(String text);
	
	/**
	 * Handle a parameter chunk (<code>$P{..}</code>).
	 * 
	 * @param text the chunk text, i.e. the parameter name
	 */
	void handleParameterChunk(String text);
	
	/**
	 * Handle a parameter clause chunk (<code>$P!{..}</code>).
	 * 
	 * @param text the chunk text, i.e. the parameter name
	 */
	void handleParameterClauseChunk(String text);
	
	/**
	 * Handle a clause chunk (<code>$X{..}</code>).
	 * 
	 * @param tokens the chunk tokens
	 */
	void handleClauseChunk(String[] tokens);

}