KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > mondrian > rolap > sql > SqlConstraint


1 /*
2 // This software is subject to the terms of the Common Public License
3 // Agreement, available at the following URL:
4 // http://www.opensource.org/licenses/cpl.html.
5 // Copyright (C) 2004-2005 TONBELLER AG
6 // All Rights Reserved.
7 // You must accept the terms of that agreement to use this software.
8 */

9 package mondrian.rolap.sql;
10
11 /**
12  * restricts the members that are fetched by SqlMemberSource.
13  * <p>
14  * @see mondrian.rolap.SqlMemberSource
15  *
16  * @author av
17  * @since Nov 2, 2005
18  */

19 public interface SqlConstraint {
20
21    /**
22     * Returns a key that becomes part of the key for caching the
23     * result of the SQL query. So SqlConstraint instances that
24     * produce the same SQL resultset must return equal keys
25     * in terms of equal() and hashCode().
26     * @return valid key or null to prevent the result from being cached
27     */

28     Object JavaDoc getCacheKey();
29 }
30
31 // End SqlConstraint.java
32
Popular Tags