01: /*
02: * Copyright (C) 1999-2004 <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: /**
21: * Clause set with a caching mechanism. In case the cache is switched off, each call of <code>clauses()</code>
22: * will build a new set of clauses in case such a set is not explicitely given but implicitely
23: * defined (e.g., by a database access description). This can be an expensive operation, so we support
24: * caching this set (e.g., during a session) and reseting the cache.
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 1.0
28: */
29: public interface CachedClauseSet extends ClauseSet {
30:
31: /**
32: * Indicates whether the cache is enabled.
33: * @return true of the cache is enabled and false otherwise
34: */
35: boolean isCacheEnabled();
36:
37: /**
38: * Reset the clause set. In particular, this may include cleaning the cache.
39: */
40: void reset();
41:
42: /**
43: * Enable / disable the cache property.
44: * @param flag true if the cache should be enabled, false if the cahe should be disabled
45: */
46: void setCacheEnabled(boolean flag);
47: }
|