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: /**
29: * This interface represents the user definition of a query.
30: *
31: * @author S.Chassande-Barrioz
32: */
33: public interface QueryDefinition {
34:
35: short TYPE_SELECT = 1;
36: short TYPE_DELETE = 2;
37: short TYPE_UPDATE = 3;
38:
39: short getQueryType();
40:
41: boolean equals(Object o);
42:
43: int hashCode();
44:
45: boolean withPrefetch();
46:
47: void withPrefetch(boolean withPrefetch);
48:
49: String qdToString(boolean oneLine);
50:
51: /**
52: * The application may want to skip some number of results that may have
53: * been previously returned, and additionally may want to limit the number
54: * of instances returned from a query. The default range for query execution
55: * if this method is not called are (0, Long.MAX_VALUE).
56: */
57: long getIndexFirst();
58:
59: /**
60: * The application may want to skip some number of results that may have
61: * been previously returned, and additionally may want to limit the number
62: * of instances returned from a query. The default range for query execution
63: * if this method is not called are (0, Long.MAX_VALUE).
64: */
65: long getIndexLast();
66:
67: boolean fetchIdentifierOnly();
68: }
|