KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jorm > genclass > api > GenClassProp


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.genclass.api;
25
26 import org.objectweb.jorm.type.api.PType;
27
28 /**
29  * It dscribes the setters for defining the properties that can be set when
30  * initialising a GenClassMapping.
31  * @author P. Dechamboux
32  */

33 public interface GenClassProp {
34     /**
35      * Defines the type property of a generic class instance.
36      * @param pt The associated type.
37      */

38     void setPType(PType pt);
39
40     /**
41      * Defines the fields property specifying the fields composing the
42      * identifier structure of a generic class instance.
43      * @param fds The array of descriptions of the associated fields.
44      */

45     void setIdentifierDesc(FieldDesc[] fds);
46
47     /**
48      * Defines the fields property specifying the fields composing the
49      * index structure of a generic class instance elements.
50      * @param fds The array of descriptions of the associated fields.
51      */

52     void setIndexDesc(FieldDesc[] fds);
53
54     /**
55      * Defines the fields property specifying the fields composing the
56      * element value structure of a generic class instance elements.
57      * @param fds The array of descriptions of the associated fields.
58      */

59     void setElemDesc(FieldDesc[] fds);
60
61 }
62
Popular Tags