KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jorm > api > PPrefetchTupleCollection


1 /**
2  * JORM: an implementation of a generic mapping system for persistent Java
3  * objects. Two mapping are supported: to RDBMS and to binary files.
4  * Copyright (C) 2001-2003 France Telecom R&D - INRIA
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * 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  * Contact: jorm-team@objectweb.org
21  *
22  */
23
24 package org.objectweb.jorm.api;
25
26 import org.objectweb.medor.tuple.api.TupleCollection;
27 import org.objectweb.medor.eval.prefetch.api.PrefetchBuffer;
28
29 /**
30  * Defines an extension of a TupleCollection to use for the prefetching
31  * mechanism. This extension permits to known the index of the PName of the
32  * persistent class which is pefetched. It permits also to reach the prefetched
33  * buffer encaspsulates behind this tuple collection.
34  *
35  * @author P.Dechamboux
36  * @author S.Chassande-Barrioz
37  *
38  */
39 public interface PPrefetchTupleCollection extends TupleCollection {
40     /**
41      * Gets the index of the PName of the persistent class which is pefetched
42      * @return an integer value greater or equal to 1.
43      */
44     int getPNameIndex();
45
46     /**
47      * Gets the PrefetchBuffer associated with the TupleCollection.
48      * @return The corresponding PrefetchBuffer.
49      */
50     PrefetchBuffer getPrefetchBuffer();
51 }
Popular Tags