01: package org.mandarax.xkb.framework;
02:
03: /**
04: * Copyright (C) 1999-2004 Jens Dietrich (mailto:mandarax@jbdietrich.com)
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation; either
09: * 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:
21: import java.util.Map;
22:
23: import org.jdom.Element;
24: import org.mandarax.kernel.LogicFactory;
25: import org.mandarax.xkb.XKBException;
26:
27: /**
28: * An XML adapter specifies how to convert an object to an element in the xml
29: * document tree, and how to recover it from a (JDOM) element.<br>
30: * @see org.jdom.Element
31: * @author <A href="http://www-ist.massey.ac.nz/JBDietrich" target="_top">Jens Dietrich</A>
32: * @version 3.4 <7 March 05>
33: * @since 1.6
34: * @deprecated from v 3.4 - support for new features such as validation will not be added to XKB, please use ZKB instead
35: */
36: public interface XMLAdapter {
37: /**
38: * Export an object, i.e., convert it to an element in the DOM.
39: * @param obj an object
40: * @param driver the generic driver
41: * @param cache a cache used in order to associate the same
42: * id with various occurences of the same object
43: * @exception an XKBException is thrown if export fails
44: */
45: public abstract Element exportObject(Object obj,
46: GenericDriver driver, Map cache) throws XKBException;
47:
48: /**
49: * Build an object from an XML element.
50: * @param e an element
51: * @param driver the generic driver
52: * @param cache a cache used to identify objects that have an id
53: * @param lfactory the logic factory used to create objects
54: * @exception an XKBException is thrown if import fails
55: */
56: public abstract Object importObject(Element e,
57: GenericDriver driver, Map cache, LogicFactory lfactory)
58: throws XKBException;
59:
60: /**
61: * Get the name of the associated tag (element).
62: * @return a string
63: */
64: public abstract String getTagName();
65:
66: /**
67: * Get the kind of object the adapter can export/import.
68: * Hint: use the constants defined in GenericDriver
69: * @return a string
70: */
71: public abstract String getKindOfObject();
72: }
|