KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > mapping > UserGenerator


1 /*
2  * This file belongs to the XQuark distribution.
3  * Copyright (C) 2003 Universite de Versailles Saint-Quentin.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307.
18  * You can also get it at http://www.gnu.org/licenses/lgpl.html
19  *
20  * For more information on this software, see http://www.xquark.org.
21  */
22
23 package org.xquark.mapping;
24
25 /** This Interface must be implemented by custom mapping users when a column of a
26  * relational table must be filled with a custom generated value.
27  *
28  * <p><B>Warning !</B></p>
29  * <p>User must also supply an object inplementing the TypeInfo interface for this
30  * generator.</p>
31  *
32  */
33 public interface UserGenerator
34 extends Generator
35 {
36     /** Return the corresponding XML Schema type using the XML Schema
37      * recommendation syntax.
38      * <p><B>You must not use the the prefix for XML Schema namespace which
39      * is implicitly defined</B></p>.
40      *
41      * <p><B>Examples:/B></p>
42      * <p>string</p>
43      * <p>decimal</p>
44      * <p><![CDATA[<simpleType><restriction base="string"><maxLength value="32"/></restriction></simpleType>]]></p>
45      *
46      * @return an XML Schema fragment describing a simple type
47      */
48     public String JavaDoc getXMLType();
49 }
50
Popular Tags