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 java.util.Map;
31:
32: import net.sf.jasperreports.engine.JRDataset;
33: import net.sf.jasperreports.engine.JRException;
34: import net.sf.jasperreports.engine.JRValueParameter;
35: import net.sf.jasperreports.engine.util.JRProperties;
36:
37: /**
38: * Factory classes used to create query executers.
39: * <p/>
40: * For each query language, a query executer factory must be created and registered as a JR property.
41: * <p/>
42: * Query executer factory instances must be thread-safe as they are cached and used as singletons.
43: *
44: * @author Lucian Chirita (lucianc@users.sourceforge.net)
45: * @version $Id: JRQueryExecuterFactory.java 1828 2007-08-24 13:58:43Z teodord $
46: * @see net.sf.jasperreports.engine.query.JRQueryExecuter
47: */
48: public interface JRQueryExecuterFactory {
49:
50: /**
51: * Prefix for query executer factory properties.
52: * <p/>
53: * To obtain query executer factories, a property having the query language appended to this prefix is used
54: * to get the query executer factory name.
55: */
56: public static final String QUERY_EXECUTER_FACTORY_PREFIX = JRProperties.PROPERTY_PREFIX
57: + "query.executer.factory.";
58:
59: /**
60: * Returns the built-in parameters associated with this query type.
61: * <p/>
62: * These parameters will be created as system-defined parameters for each
63: * report/dataset having a query of this type.
64: * <p/>
65: * The returned array should contain consecutive pairs of parameter names and parameter classes
66: * (e.g. <code>{"Param1", String.class, "Param2", "List.class"}</code>).
67: *
68: * @return array of built-in parameter names and types associated with this query type
69: */
70: public Object[] getBuiltinParameters();
71:
72: /**
73: * Creates a query executer.
74: * <p/>
75: * This method is called at fill time for reports/datasets having a query supported by
76: * this factory.
77: *
78: * @param dataset the dataset containing the query, fields, etc
79: * @param parameters map of value parameters (instances of {@link JRValueParameter JRValueParameter})
80: * indexed by name
81: *
82: * @return a query executer
83: * @throws JRException
84: */
85: public JRQueryExecuter createQueryExecuter(JRDataset dataset,
86: Map parameters) throws JRException;
87:
88: /**
89: * Decides whether the query executers created by this factory support a query parameter type.
90: * <p/>
91: * This check is performed for all $P{..} parameters in the query.
92: *
93: * @param className the value class name of the parameter
94: * @return whether the parameter value type is supported
95: */
96: public boolean supportsQueryParameterType(String className);
97:
98: }
|