KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > map > DbKeyGenerator


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */

56
57 package org.objectstyle.cayenne.map;
58
59 import org.objectstyle.cayenne.util.XMLEncoder;
60
61 /**
62  * DbKeyGenerator is an abstraction of a primary key generator
63  * It configures the primary key generation per DbEntity in a RDBMS independent
64  * manner. DbAdapter generates actual key values based on the configuration.
65  * For more details see data-map.dtd
66  *
67  * @author Andriy Shapochka
68  */

69
70 public class DbKeyGenerator extends MapObject {
71     public static final String JavaDoc ORACLE_TYPE = "ORACLE";
72     public static final String JavaDoc NAMED_SEQUENCE_TABLE_TYPE = "NAMED_SEQUENCE_TABLE";
73
74     private String JavaDoc generatorType;
75     private Integer JavaDoc keyCacheSize;
76     private String JavaDoc generatorName;
77
78     public DbKeyGenerator() {
79     }
80
81     /**
82      * Prints itself as XML to the provided XMLEncoder.
83      *
84      * @since 1.1
85      */

86     public void encodeAsXML(XMLEncoder encoder) {
87
88         String JavaDoc type = getGeneratorType();
89         if (type == null) {
90             return;
91         }
92
93         encoder.println("<db-key-generator>");
94         encoder.indent(1);
95
96         encoder.print("<db-generator-type>");
97         encoder.print(type);
98         encoder.println("</db-generator-type>");
99
100         String JavaDoc name = getGeneratorName();
101         if (name != null) {
102             encoder.print("<db-generator-name>");
103             encoder.print(name);
104             encoder.println("</db-generator-name>");
105         }
106
107         Integer JavaDoc cacheSize = getKeyCacheSize();
108         if (cacheSize != null) {
109             encoder.print("<db-key-cache-size>");
110             encoder.print(String.valueOf(cacheSize));
111             encoder.println("</db-key-cache-size>");
112         }
113
114         encoder.indent(-1);
115         encoder.println("</db-key-generator>");
116     }
117
118     public DbEntity getDbEntity() {
119         return (DbEntity) getParent();
120     }
121
122     public void setDbEntity(DbEntity entity) {
123         setParent(entity);
124     }
125
126     public void setGeneratorType(String JavaDoc generatorType) {
127         this.generatorType = generatorType;
128         if (this.generatorType != null) {
129             this.generatorType = this.generatorType.trim().toUpperCase();
130             if (!(ORACLE_TYPE.equals(this.generatorType)
131                 || NAMED_SEQUENCE_TABLE_TYPE.equals(this.generatorType)))
132                 this.generatorType = null;
133         }
134     }
135
136     public String JavaDoc getGeneratorType() {
137         return generatorType;
138     }
139
140     public void setKeyCacheSize(Integer JavaDoc keyCacheSize) {
141         this.keyCacheSize = keyCacheSize;
142         if (this.keyCacheSize != null && this.keyCacheSize.intValue() < 1) {
143             this.keyCacheSize = null;
144         }
145     }
146
147     public Integer JavaDoc getKeyCacheSize() {
148         return keyCacheSize;
149     }
150
151     public void setGeneratorName(String JavaDoc generatorName) {
152         this.generatorName = generatorName;
153         if (this.generatorName != null) {
154             this.generatorName = this.generatorName.trim();
155             if (this.generatorName.length() == 0)
156                 this.generatorName = null;
157         }
158     }
159
160     public String JavaDoc getGeneratorName() {
161         return generatorName;
162     }
163
164     public String JavaDoc toString() {
165         return "{Type="
166             + generatorType
167             + ", Name="
168             + generatorName
169             + ", Cache="
170             + keyCacheSize
171             + "}";
172     }
173 }
Popular Tags