01: /**
02: * Speedo: an implementation of JDO compliant personality on top of JORM generic
03: * I/O sub-system.
04: * Copyright (C) 2001-2004 France Telecom R&D
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation; either
09: * version 2 of the License, or (at your option) any later version.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this library; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: *
20: *
21: *
22: * Contact: speedo@objectweb.org
23: *
24: * Authors: S.Chassande-Barrioz.
25: *
26: */package org.objectweb.speedo.query.api;
27:
28: import org.objectweb.medor.api.MedorException;
29: import org.objectweb.medor.expression.api.ExpressionException;
30: import org.objectweb.perseus.cache.api.FixableCacheEntry;
31: import org.objectweb.speedo.api.SpeedoException;
32: import org.objectweb.speedo.pm.api.POManagerItf;
33:
34: import java.util.Map;
35:
36: /**
37: * Represents a compiled JDO query.
38: *
39: * @author S.Chassande-Barrioz
40: */
41: public interface CompiledQuery extends FixableCacheEntry {
42:
43: short UNDEFINED = 0;
44: short DEFINED = 1;
45: short COMPILED = 2;
46:
47: /**
48: * @return the query status. The possible values are UNDEFINED, DEFINED
49: * or COMPILED.
50: */
51: short getStatus();
52:
53: /**
54: * @return the definition of the query if it is defined, null value
55: * otherwise.
56: */
57: QueryDefinition getDefinition();
58:
59: /**
60: * Compiles the query if it is not already done.
61: */
62: void compile() throws SpeedoException, MedorException,
63: ExpressionException;
64:
65: /**
66: * Executes the compiled query.
67: * @param parameters is the JDO parameters of query (does not contains
68: * internal parameter). The order of parameter must match the parameter
69: * declaration.
70: * @param pm is the po manager representing the execution context. It
71: * also used to load the instance in the result collection.
72: * @param qd TODO
73: * @return a list or one persistent instance depending on the unique flag.
74: * The result can be null only if the result is unique.
75: */
76: Object execute(Object[] parameters, POManagerItf pm,
77: QueryDefinition qd) throws SpeedoException, MedorException,
78: ExpressionException;
79:
80: Object execute(Map parameters, POManagerItf pm, QueryDefinition qd)
81: throws SpeedoException, MedorException, ExpressionException;
82:
83: }
|