001: package org.mandarax.zkb;
002:
003: /*
004: * Copyright (C) 1999-2004 <A href="http://www-ist.massey.ac.nz/JBDietrich" target="_top">Jens Dietrich</a>
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2 of the License, or (at your option) any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
019: */
020:
021: import org.jdom.Document;
022: import org.mandarax.kernel.KnowledgeBase;
023: import org.mandarax.util.logging.LogCategories;
024:
025: /**
026: * Interface for zkb driver that can import / export knowledge bases from/to
027: * xml data sources. XML data sources are represented by JDOM objects.
028: * Similar to XKB drivers, but does not store objects in the XML but manages them
029: * in a map that is stored separatly in a resource file. This is done by a delagate called Object Persistency Service.
030: * The main xml file and the resource file plus additional meta information are then wrapped together in a zip archive.
031: * @author <A href="http://www-ist.massey.ac.nz/JBDietrich" target="_top">Jens Dietrich</A>
032: * @version 3.4 <7 March 05>
033: * @since 2.2
034: * @see ObjectPersistencyService
035: */
036:
037: public interface ZKBDriver extends LogCategories {
038:
039: // constants for the different policies to reference the DTD
040: public static final int NO_DTD_REF = 0;
041: public static final int INTERNAL_DTD_REF = 1;
042: public static final int EXTERNAL_DTD_REF = 2;
043: public static final int JUST_INCLUDE_DTD = 3;
044:
045: /**
046: * Export a knowledge base, i.e., convert it into an xml document.
047: * All encountered object references should be registered with the ops.
048: * @return an xml document
049: * @param kb a knowledge base
050: * @param ops an object persistency service
051: * @throws an ZKBException is thrown if export fails
052: */
053: Document exportKnowledgeBase(KnowledgeBase kb,
054: ObjectPersistencyService ops) throws ZKBException;
055:
056: /**
057: * Get a short text describing the driver.
058: * @return a text
059: */
060: String getDescription();
061:
062: /**
063: * Get the location (URL) of the associated DTD.
064: * @return an url
065: */
066: String getURL4DTD();
067:
068: /**
069: * Get the name of the driver.
070: * @return a text
071: */
072: String getName();
073:
074: /**
075: * Import a knowledge base, i.e., build it from an xml document.
076: * @return a knowledge base
077: * @param doc an xml document
078: * @param ops the object persistency service
079: * @throws an XKBException is thrown if import fails
080: */
081: KnowledgeBase importKnowledgeBase(Document doc,
082: ObjectPersistencyService ops) throws ZKBException;
083:
084: /**
085: * Indicates whether the driver (and the underlying xml format (=dtd))
086: * supports auto facts.
087: * @return a boolean
088: */
089: boolean supportsAutoFacts();
090:
091: /**
092: * Indicates whether the driver (and the underlying xml format (=dtd))
093: * supports clause sets.
094: * @return a boolean
095: */
096: boolean supportsClauseSets();
097:
098: /**
099: * Indicates whether the driver (and the underlying xml format (=dtd))
100: * supports facts. (some formats might see facts as rules without body)
101: * @return a boolean
102: */
103: boolean supportsFacts();
104:
105: /**
106: * Indicates whether the driver (and the underlying xml format (=dtd))
107: * supports functions.
108: * @return a boolean
109: */
110: boolean supportsFunctions();
111:
112: /**
113: * Indicates whether the driver (and the underlying xml format (=dtd))
114: * supports the java semantics (e.g. JFunctions, JPredicate).
115: * @return a boolean
116: */
117: boolean supportsJavaSemantics();
118:
119: /**
120: * Indicates whether the driver (and the underlying xml format (=dtd))
121: * supports multiple premises.
122: * @return a boolean
123: */
124: boolean supportsMultiplePremises();
125:
126: /**
127: * Indicates whether the driver (and the underlying xml format (=dtd))
128: * supports multiple premises connected by OR.
129: * @return a boolean
130: */
131: boolean supportsOrPremises();
132:
133: /**
134: * Indicates whether the driver (and the underlying xml format (=dtd))
135: * supports types.
136: * @return a boolean
137: */
138: boolean supportsTypes();
139:
140: /**
141: * Indicates whether the driver (and the underlying xml format (=dtd))
142: * supports queries.
143: * @return a boolean
144: */
145: boolean supportsQueries();
146:
147: /**
148: * Get the dtd reference policy.
149: * @return int
150: */
151: public int getDtdRefPolicy();
152:
153: /**
154: * Sets the dtd reference policy.
155: * @param dtdRefPolicy The dtd reference policy to set
156: */
157: public void setDtdRefPolicy(int dtdRefPolicy);
158: }
|