01: /*
02: * Copyright (C) 1998-2002 <A href="http://www-ist.massey.ac.nz/JBDietrich" target="_top">Jens Dietrich</a>
03: *
04: * This library is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2 of the License, or (at your option) any later version.
08: *
09: * This library is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */
18: package org.mandarax.kernel;
19:
20: import java.util.Map;
21:
22: /**
23: * Object representing a session. A session is initiated when the query is issued and terminated when the
24: * inference engine returns the result set.
25: * @author <A href="http://www-ist.massey.ac.nz/JBDietrich" target="_top">Jens Dietrich</A>
26: * @version 3.4 <7 March 05>
27: * @since 3.2
28: */
29: public interface Session {
30:
31: /**
32: * Get a unique session id.
33: * @return a session id
34: */
35: public Object getId();
36:
37: /**
38: * Set (bind) a session attribute.
39: * @param attrName the attribute name
40: * @param attrValue an attribute value
41: */
42: public void setAttribute(Object attrName, Object attrValue);
43:
44: /**
45: * Get (lookup) a session attribute.
46: * @param attrName the attribute name
47: * @return the attribute value (null indicates that there was no registered value.
48: */
49: public Object getAttribute(Object attrName);
50:
51: /**
52: * Get the knowledge base used in this session.
53: * @return a knowledge base
54: */
55: public KnowledgeBase getKnowledgeBase();
56:
57: /**
58: * Get the inference engine used in this session.
59: * @return an inference engine
60: */
61: public InferenceEngine getInferenceEngine();
62:
63: /**
64: * Get the query for this session.
65: * @return a query
66: */
67: public Query getQuery();
68:
69: /**
70: * Get the exception handling strategy used in this session.
71: * @return an integer
72: * @see InferenceEngine.BUBBLE_EXEPTIONS
73: * @see InferenceEngine.TRY_NEXT
74: */
75: public int getExceptionHandlingStrategy();
76:
77: /**
78: * Get the cardinality constraints for this session.
79: * @return an integer
80: * @see InferenceEngine.ALL
81: */
82: public int getCardinalityContraint();
83:
84: /**
85: * Get a map containing the current query variable replacements.
86: * I.e., the map contains association VariableTerm -> ConstantTerm
87: * @return a map
88: */
89: public Map getVariableReplacements();
90:
91: }
|