KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > medor > query > jorm > api > JormExtent


1 /**
2  * MEDOR: Middleware Enabling Distributed Object Requests
3  *
4  * Copyright (C) 2001-2003 France Telecom R&D
5  * Contact: alexandre.lefebvre@rd.francetelecom.com
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  *
21  * Initial developers: M. Alia, A. Lefebvre, S. Chassande-Barrioz
22  */
23 package org.objectweb.medor.query.jorm.api;
24
25 import org.objectweb.jorm.api.PMapper;
26 import org.objectweb.jorm.metainfo.api.MetaObject;
27 import org.objectweb.medor.query.api.QueryLeaf;
28 import org.objectweb.medor.datasource.api.DataStore;
29
30 /**
31  * This class represent a a jorm query leaf.
32  *
33  * @author S.Chassande-Barrioz
34  */
35 public interface JormExtent extends QueryLeaf {
36
37     PMapper getPMapper();
38
39     void setPMapper(PMapper m, String JavaDoc projectName);
40
41     String JavaDoc getProjectName();
42
43     void setProjectName(String JavaDoc projectName);
44
45     String JavaDoc getPNameFieldName();
46
47     void setDataStore(DataStore ds);
48
49     String JavaDoc getJormName();
50
51     JormField getIdentifierField();
52
53     MetaObject getMetaObject();
54
55     /**
56      * Tells whether the current Extent should also contain objects from the
57      * subclasses.
58      * <p>The default is that only objects strictly in the current class are
59      * included, and not objects of the subclasses.
60      * @return true if objects from subclasses are to be included, false if
61      * only strict instances of the corresponding class should be included.
62      */
63     boolean withSubClasses();
64
65     /**
66      * Indicates whether the current Extent should also contain objects from the
67      * subclasses.
68      * <p>The default is that only objects strictly in the current class are
69      * included, and not objects of the subclasses.
70      * @param includeSubClasses is true if objects from subclasses are to be
71      * included, false if only strict instances of the corresponding class
72      * should be included.
73      */
74     void setWithSubClasses(boolean includeSubClasses);
75 }
76
Popular Tags