01: /*
02: * ============================================================================
03: * GNU Lesser General Public License
04: * ============================================================================
05: *
06: * JasperReports - Free Java report-generating library.
07: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
08: *
09: * This library is free software; you can redistribute it and/or
10: * modify it under the terms of the GNU Lesser General Public
11: * License as published by the Free Software Foundation; either
12: * version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17: * Lesser General Public License for more details.
18: *
19: * You should have received a copy of the GNU Lesser General Public
20: * License along with this library; if not, write to the Free Software
21: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22: *
23: * JasperSoft Corporation
24: * 303 Second Street, Suite 450 North
25: * San Francisco, CA 94107
26: * http://www.jaspersoft.com
27: */
28: package net.sf.jasperreports.engine.query;
29:
30: import net.sf.jasperreports.engine.JRValueParameter;
31:
32: /**
33: * A query clause handling context, as seen from a {@link JRClauseFunction clause function}.
34: *
35: * @author Lucian Chirita (lucianc@users.sourceforge.net)
36: * @version $Id: JRQueryClauseContext.java 1683 2007-03-29 16:04:15Z lucianc $
37: */
38: public interface JRQueryClauseContext {
39:
40: /**
41: * Returns the query text buffer.
42: *
43: * @return the query text buffer
44: */
45: StringBuffer queryBuffer();
46:
47: /**
48: * Return a value parameter from the report parameters map.
49: *
50: * @param parameterName the parameter name
51: * @return the parameter
52: */
53: JRValueParameter getValueParameter(String parameterName);
54:
55: /**
56: * Records a query parameter.
57: *
58: * @param parameterName the parameter name
59: */
60: void addQueryParameter(String parameterName);
61:
62: /**
63: * Records a multi-valued query parameter.
64: *
65: * @param parameterName the parameter name
66: * @param count the value count
67: */
68: void addQueryMultiParameters(String parameterName, int count);
69:
70: }
|