KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > speedo > mapper > api > JormFactoryAttributes


1 /**
2  * Copyright (C) 2001-2004 France Telecom R&D
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */

18 package org.objectweb.speedo.mapper.api;
19
20 import org.objectweb.fractal.api.control.AttributeController;
21
22 import java.util.Properties JavaDoc;
23
24 /**
25  * defines the attributes (Fractal attribute Controller) of the JormFactory
26  * component.
27  *
28  * @see org.objectweb.speedo.mapper.api.JormFactory
29  * @author S.Chassande-Barrioz
30  */

31 public interface JormFactoryAttributes extends AttributeController {
32
33     /**
34      * nothing is done. Then the mapping structures already exist at the Speedo
35      * starting
36      */

37     byte DO_NOTHING = 0;
38
39     /**
40      * The mapping structures are created if they are not already present
41      */

42     byte CREATE_IF_REQUIRED = 1;
43
44     /**
45      * The mapping structures are removed (if they already exist), and created.
46      */

47     byte FORCE_CREATE = 2;
48
49     /**
50      * The data present in the mapping structure are removed. Of course if the
51      * mapping structure do not exist, they are created.
52      */

53     byte DELETE_DATA = 3;
54
55     /**
56      * @return the default mapping structure rule applied during the map
57      * operation of the persistent classes.
58      */

59     byte getMappingStructureRule();
60
61     /**
62      *
63      * @param rule is the default mapping structure rule to apply during the map
64      * operation of the persistent classes.
65      */

66     void setMappingStructureRule(byte rule);
67
68     /**
69      * Indicates if during the class registration, the persistent classes have
70      * to be mapped.
71      * True : the class are mapped at class registration time
72      * False: nothing is done.
73      */

74     boolean getMappingOnClassRegistration();
75
76     /**
77      *
78      * @param val is a boolean value Indicating if during the class
79      * registration, the persistent classes have to be mapped.
80      * True : the class are mapped at class registration time
81      * False: nothing is done.
82      */

83     void setMappingOnClassRegistration(boolean val);
84     
85     /**
86      * Assignes speedo properties which permits to configure each home
87      * (caching, ...)
88      */

89     void setSpeedoProperties(Properties JavaDoc p);
90     
91     /**
92      * Returns speedo properties used to configure each home
93      * (caching, ...)
94      */

95     Properties JavaDoc getSpeedoProperties();
96 }
97
Popular Tags