01: package org.mandarax.zkb.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 org.jdom.Element;
22: import org.mandarax.kernel.LogicFactory;
23: import org.mandarax.zkb.ObjectPersistencyService;
24: import org.mandarax.zkb.ZKBException;
25:
26: /**
27: * An XML adapter specifies how to convert a predicate to an element in the xml
28: * document tree, and how to recover it from a (JDOM) element.<br>
29: * @see org.jdom.Element
30: * @author <A href="http://www-ist.massey.ac.nz/JBDietrich" target="_top">Jens Dietrich</A>
31: * @version 3.4 <7 March 05>
32: * @since 2.2
33: */
34: public interface Adapter {
35:
36: /**
37: * Export an object, i.e., convert it to an element in the DOM.
38: * @param obj an object
39: * @param driver the generic driver
40: * @param ops an object persistency service
41: * @exception a ZKBException is thrown if export fails
42: */
43: public abstract Element exportObject(Object obj,
44: GenericDriver driver, ObjectPersistencyService ops)
45: throws ZKBException;
46:
47: /**
48: * Build an object from an XML element.
49: * @param e an element
50: * @param driver the generic driver
51: * @param ops an object persistency service
52: * @param lfactory the logic factory used to create objects
53: * @exception a ZKBException is thrown if import fails
54: */
55: public abstract Object importObject(Element e,
56: GenericDriver driver, ObjectPersistencyService ops,
57: LogicFactory lfactory) throws ZKBException;
58:
59: /**
60: * Get the name of the associated tag (element).
61: * @return a string
62: */
63: public abstract String getTagName();
64:
65: /**
66: * Print the DTD associated with this adapter on a string buffer.
67: * @param out the buffer to print on.
68: */
69: public abstract void printDTD(StringBuffer out);
70:
71: }
|