View Javadoc

1   /*
2    * Copyright (c) 2004-2005, University Health Network.  All rights reserved. Distributed under the BSD 
3    * license (see http://opensource.org/licenses/bsd-license.php).
4    *  
5    * Created on 6-Dec-2004
6    */
7   package ca.uhn.cache;
8   
9   /***
10   * <p>An axis of a <code>IParamSpace</code>, along which data are divided into 
11   * <code>IChunk</code>s.</p>
12   * 
13   * <p>Conceptually, a dimension may be continuous (e.g. time), or discrete (e.g. 
14   * categories).  This is reflected in the application parameter types (see 
15   * getParamTypes()).</p>  
16   *     
17   * @author <a href="mailto:alexei.guevara@uhn.on.ca">Alexei Guevara</a>
18   * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
19   * @version $Revision: 1.1 $ updated on $Date: 2005/01/24 22:52:08 $ by $Author: bryan_tripp $
20   */
21  public interface IDimension {
22      
23      /***
24       * @return the name of the dimension (unique within a space)  
25       */
26      public String getName();
27      
28      /***
29       * @return the types of the <code>IQueryParam</code>s that are meaningful 
30       *      along this dimension
31       */
32      public Class[] getParamTypes();
33  
34  }