Source code: com/tripi/asp/MapNode.java
1 /**
2 * ArrowHead ASP Server
3 * This is a source file for the ArrowHead ASP Server - an 100% Java
4 * VBScript interpreter and ASP server.
5 *
6 * For more information, see http://www.tripi.com/arrowhead
7 *
8 * Copyright (C) 2002 Terence Haddock
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 *
24 */
25 package com.tripi.asp;
26
27 /**
28 * MapNode is an interface to a multi-dimensional array.
29 *
30 * @author Terence Haddock
31 * @version 0.9
32 */
33 public interface MapNode extends Node
34 {
35 /**
36 * Obtains the value of this map node at the specified index.
37 * To handle multi-dimensional arrays, the index is given as a list
38 * of parameters.
39 * @param varlist multi-dimension index of value to obtain from this map.
40 * @param context Context under which this map is evaluated.
41 * @return value of the map at the specified index(es)
42 * @throws AspException if an error occurs
43 */
44 public Object getIndex(VarListNode varlist, AspContext context)
45 throws AspException;
46
47 /**
48 * Obtains the upper bound of this map.
49 * @param dimension Dimension of which to obtain upper bound of
50 * @return upper bound of this map
51 * @throws AspException if an error occurs
52 */
53 public int getUBOUND(int dimension) throws AspException;
54
55 /**
56 * Obtains the lower bound of this map.
57 * @param dimension Dimension of which to obtain lower bound of
58 * @return lower bound of this map
59 * @throws AspException if an error occurs
60 */
61 public int getLBOUND(int dimension) throws AspException;
62 }
63