|
|
|||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
com.northgateis.reality.realsql
Class RealSQLArray
java.lang.Object | +--com.northgateis.reality.realsql.RealSQLArray
- public class RealSQLArray
- extends java.lang.Object
- implements java.sql.Array
- extends java.lang.Object
None of the methods in this class have been implemented, it has been created for testing purposes only..
| Constructor Summary | |
RealSQLArray()
Default constructor, does nothing except call super(); |
|
| Method Summary | |
java.lang.Object | getArray()Retrieves the contents of the SQL array designated by this Array object in the form of an array in the Java programming language. |
java.lang.Object | getArray(long index,
int count)Returns an array containing a slice of the SQL array, beginning with the specified index and containing up to count successive elements of the SQL array. |
java.lang.Object | getArray(long index,
int count,
java.util.Map map)Returns an array containing a slice of the SQL array object designated by this object, beginning with the specified index and containing up to count successive elements of the SQL array. |
java.lang.Object | getArray(java.util.Map map)Retrieves the contents of the SQL array designated by this Array object, using the specified map for type map customizations. |
int | getBaseType()Returns the JDBC type of the elements in the array designated by this Array object. |
java.lang.String | getBaseTypeName()Returns the SQL type name of the elements in the array designated by this Array object. |
java.sql.ResultSet | getResultSet()Returns a result set that contains the elements of the array designated by this Array object. |
java.sql.ResultSet | getResultSet(long index,
int count)Returns a result set holding the elements of the subarray that starts at index index and contains up to count successive elements. |
java.sql.ResultSet | getResultSet(long index,
int count,
java.util.Map map)Returns a result set holding the elements of the subarray that starts at index index and contains up to count successive elements. |
java.sql.ResultSet | getResultSet(java.util.Map map)Returns a result set that contains the elements of the array designated by this Array object and uses the given map to map the array elements. |
| Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
| Constructor Detail |
RealSQLArray
public RealSQLArray()
- Default constructor, does nothing except call super();
| Method Detail |
getBaseTypeName
public java.lang.String getBaseTypeName() throws java.sql.SQLException
- Returns the SQL type name of the elements in the array designated by this Array
object. If the elements are a built-in type, it returns the database-specific
type name of the elements. If the elements are a user-defined type (UDT),
this method returns the fully-qualified SQL type name.
Returns:a String that is the database-specific name for a built-in base type
or the fully-qualified SQL type name for a base type that is a
UDTThrows:SQLException - if an error occurs while attempting to access the
type name getBaseType
- Specified by:
- getBaseTypeName in interface java.sql.Array
getBaseType
public int getBaseType() throws java.sql.SQLException
- Returns the JDBC type of the elements in the array designated by this Array
object. Returns:a constant from the class Types that is the type code for
the elements in the array designated by this Array object.
Throws:SQLException - if an error occurs while attempting to access the base
type getArray
- Specified by:
- getBaseType in interface java.sql.Array
getArray
public java.lang.Object getArray() throws java.sql.SQLException
- Retrieves the contents of the SQL array designated by this Array object in
the form of an array in the Java programming language. This version of the
method getArray uses the type map associated with the connection for
customizations of the type mappings. Returns:an array in the Java programming
language that contains the ordered elements of the SQL ARRAY object designated
by this objectThrows:SQLException - if an error occurs while attempting to
access the array getArray
- Specified by:
- getArray in interface java.sql.Array
getArray
public java.lang.Object getArray(java.util.Map map) throws java.sql.SQLException
- Retrieves the contents of the SQL array designated by this Array object,
using the specified map for type map customizations. If the base type of
the array does not match a user-defined type in map, the standard mapping
is used instead. Parameters:map - a java.util.Map object that contains
mappings of SQL type names to classes in the Java programming language
Returns:an array in the Java programming language that contains the ordered
elements of the SQL array designated by this object
Throws:SQLException - if an error occurs while attempting to access the
array getArray
- Specified by:
- getArray in interface java.sql.Array
getArray
public java.lang.Object getArray(long index, int count) throws java.sql.SQLException
- Returns an array containing a slice of the SQL array, beginning with the
specified index and containing up to count successive elements of the SQL array.
This method uses the type-map associated with the connection for customizations
of the type-mappings. Parameters:index - the array index of the first element
to retrieve; the first element is at index 1count - the number of successive
SQL array elements to retrieveReturns:an array containing up to count
consecutive elements of the SQL array, beginning with element index
Throws:SQLException - if an error occurs while attempting to access the
array getArray
- Specified by:
- getArray in interface java.sql.Array
getArray
public java.lang.Object getArray(long index, int count, java.util.Map map) throws java.sql.SQLException
- Returns an array containing a slice of the SQL array object designated by
this object, beginning with the specified index and containing up to count
successive elements of the SQL array. This method uses the specified map for
type-map customizations unless the base type of the array does not match a
user- defined type in map, in which case it uses the standard mapping.
Parameters:index - the array index of the first element to retrieve; the
first element is at index 1count - the number of successive SQL array elements
to retrievemap - a java.util.Map object that contains SQL type names and the
classes in the Java programming language to which they are mapped
Returns:an array containing up to count consecutive elements of the SQL array
designated by this Array object, beginning with element index.
Throws:SQLException - if an error occurs while attempting to access the array
getResultSet
- Specified by:
- getArray in interface java.sql.Array
getResultSet
public java.sql.ResultSet getResultSet() throws java.sql.SQLException
- Returns a result set that contains the elements of the array designated by
this Array object. If appropriate, the elements of the array are mapped using
the connection's type map; otherwise, the standard mapping is used.
The result set contains one row for each array element, with two columns in
each row. The second column stores the element value; the first column stores
the index into the array for that element (with the first array element
being at index 1). The rows are in ascending order corresponding to the order
of the indices. Returns:a ResultSet object containing one row for each of
the elements in the array designated by this Array object, with the rows in
ascending order based on the indices.
Throws:SQLException - if an error occurs while attempting to access the array
getResultSet
- Specified by:
- getResultSet in interface java.sql.Array
getResultSet
public java.sql.ResultSet getResultSet(java.util.Map map) throws java.sql.SQLException
- Returns a result set that contains the elements of the array designated by
this Array object and uses the given map to map the array elements.
If the base type of the array does not match a user-defined type in map,
the standard mapping is used instead. The result set contains one row for
each array element, with two columns in each row. The second column stores
the element value; the first column stores the index into the array for that
element (with the first array element being at index 1). The rows are in
ascending order corresponding to the order of the indices.
Parameters:map - contains mapping of SQL user-defined types to classes in the
Java(tm) programming languageReturns:a ResultSet object containing one row
for each of the elements in the array designated by this Array object,
with the rows in ascending order based on the indices.
Throws:SQLException - if an error occurs while attempting to access the array
getResultSet
- Specified by:
- getResultSet in interface java.sql.Array
getResultSet
public java.sql.ResultSet getResultSet(long index, int count) throws java.sql.SQLException
- Returns a result set holding the elements of the subarray that starts at
index index and contains up to count successive elements. This method uses
the connection's type map to map the elements of the array if the map
contains an entry for the base type. Otherwise, the standard mapping is used.
The result set has one row for each element of the SQL array designated by
this object, with the first row containing the element at index index.
The result set has up to count rows in ascending order based on the indices.
Each row has two columns: The second column stores the element value; the first
column stroes the index into the array for that element.
Parameters:index - the array index of the first element to retrieve;
the first element is at index 1count - the number of successive SQL array
elements to retrieveReturns:a ResultSet object containing up to count
consecutive elements of the SQL array designated by this Array object,
starting at index index.Throws:SQLException - if an error occurs while
attempting to access the array getResultSet
- Specified by:
- getResultSet in interface java.sql.Array
getResultSet
public java.sql.ResultSet getResultSet(long index, int count, java.util.Map map) throws java.sql.SQLException
- Returns a result set holding the elements of the subarray that starts at
index index and contains up to count successive elements. This method uses the
Map object map to map the elements of the array unless the base type of the
array does not match a user-defined type in map, in which case it uses the
standard mapping. The result set has one row for each element of the SQL array
designated by this object, with the first row containing the element at index
index. The result set has up to count rows in ascending order based on the
indices. Each row has two columns: The second column stores the element value;
the first column stroes the index into the array for that element.
Parameters:index - the array index of the first element to retrieve; the first
element is at index 1count - the number of successive SQL array elements to
retrievemap - the Map object that contains the mapping of SQL type names to
classes in the Java(tm) programming languageReturns:a ResultSet object
containing up to count consecutive elements of the SQL array designated by this
Array object, starting at index index. Throws:SQLException - if an error occurs
while attempting to access the array
- Specified by:
- getResultSet in interface java.sql.Array
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||