KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > rmijdbc > RJArrayInterface


1
2 /**
3  * RmiJdbc client/server JDBC Driver
4  * (C) ExperLog 1999-2000
5  *
6  * @version 1.0
7  * @author Pierre-Yves Gibello (pierreyves.gibello@experlog.com)
8  */

9
10 package org.objectweb.rmijdbc;
11
12 import java.sql.*;
13 import java.rmi.RemoteException JavaDoc;
14 import java.util.Map JavaDoc;
15
16 /**
17  * The mapping in the Java programming language for the SQL type ARRAY.
18  * By default, an Array is a transaction duration reference to an SQL array.
19  * By default, an Array is implemented using an SQL LOCATOR(array) internally.
20  */

21
22 public interface RJArrayInterface extends java.rmi.Remote JavaDoc
23 {
24   /**
25    * Retrieves the contents of the SQL array designated by this Array object
26    * in the form of an array in the Java programming language.
27    */

28   Object JavaDoc getArray()
29   throws RemoteException JavaDoc, SQLException;
30
31   /**
32    * Returns an array containing a slice of the SQL array, beginning with the
33    * specified index and containing up to count successive elements of the
34    * SQL array.
35    */

36   Object JavaDoc getArray(long index, int count)
37   throws RemoteException JavaDoc, SQLException;
38
39   /**
40    * Returns an array containing a slice of the SQL array object designated by
41    * this object, beginning with the specified index and containing up to
42    * count successive elements of the SQL array.
43    */

44   Object JavaDoc getArray(long index, int count, Map JavaDoc map)
45   throws RemoteException JavaDoc, SQLException;
46
47   /**
48    * Retrieves the contents of the SQL array designated by this Array object,
49    * using the specified map for type map customizations.
50    */

51   Object JavaDoc getArray(Map JavaDoc map)
52   throws RemoteException JavaDoc, SQLException;
53
54   /**
55    * Returns the JDBC type of the elements in the array designated by this
56    * Array object.
57    */

58   int getBaseType()
59   throws RemoteException JavaDoc, SQLException;
60
61   /**
62    * Returns the SQL type name of the elements in the array designated by this
63    * Array object.
64    */

65   String JavaDoc getBaseTypeName()
66   throws RemoteException JavaDoc, SQLException;
67
68   /**
69    * Returns a result set that contains the elements of the array
70    * designated by this Array object.
71    */

72   RJResultSetInterface getResultSet()
73   throws RemoteException JavaDoc, SQLException;
74
75   /**
76    * Returns a result set holding the elements of the subarray that starts
77    * at index index and contains up to count successive elements.
78    */

79   RJResultSetInterface getResultSet(long index, int count)
80   throws RemoteException JavaDoc, SQLException;
81
82   /**
83    * Returns a result set holding the elements of the subarray that starts
84    * at index index and contains up to count successive elements.
85    */

86   RJResultSetInterface getResultSet(long index, int count, Map JavaDoc map)
87   throws RemoteException JavaDoc, SQLException;
88
89   /**
90    * Returns a result set that contains the elements of the array designated
91    * by this Array object and uses the given map to map the array elements.
92    */

93   RJResultSetInterface getResultSet(Map JavaDoc map)
94   throws RemoteException JavaDoc, SQLException;
95
96 };
97
98
Popular Tags