public class FBArray
extends java.lang.Object
implements java.sql.Array
Array
Constructor and Description |
---|
FBArray() |
Modifier and Type | Method and Description |
---|---|
void |
free()
This method frees the
Array object and releases the resources that
it holds. |
java.lang.Object |
getArray()
Retrieves the contents of the SQL
ARRAY value 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
value designated by this Array object, 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
Array 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. |
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 SQL
ARRAY value
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 SQL
ARRAY value
designated by this Array object. |
public java.lang.String getBaseTypeName() throws java.sql.SQLException
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.getBaseTypeName
in interface java.sql.Array
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 UDTjava.sql.SQLException
- if an error occurs while attempting
to access the type namepublic int getBaseType() throws java.sql.SQLException
Array
object.getBaseType
in interface java.sql.Array
Types
that is
the type code for the elements in the array designated by this
Array
object.java.sql.SQLException
- if an error occurs while attempting
to access the base typepublic java.lang.Object getArray() throws java.sql.SQLException
ARRAY
value 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.getArray
in interface java.sql.Array
ARRAY
value
designated by this objectjava.sql.SQLException
- if an error occurs while attempting to
access the arraypublic java.lang.Object getArray(java.util.Map map) throws java.sql.SQLException
Array
object.
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. This version of the method
getArray
uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.getArray
in interface java.sql.Array
map
- a java.util.Map
object that contains mappings
of SQL type names to classes in the Java programming languagejava.sql.SQLException
- if an error occurs while attempting to
access the arraypublic java.lang.Object getArray(long index, int count) throws java.sql.SQLException
ARRAY
value designated by this Array
object, 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.getArray
in interface java.sql.Array
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 retrievecount
consecutive elements
of the SQL array, beginning with element index
java.sql.SQLException
- if an error occurs while attempting to
access the arraypublic java.lang.Object getArray(long index, int count, java.util.Map map) throws java.sql.SQLException
Array
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. This version of the method
getArray
uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.
getArray
in interface java.sql.Array
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 mappedcount
consecutive elements of the SQL array designated by this
Array
object, beginning with element
index
.java.sql.SQLException
- if an error occurs while attempting to
access the arraypublic java.sql.ResultSet getResultSet() throws java.sql.SQLException
ARRAY
value
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.
getResultSet
in interface java.sql.Array
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.java.sql.SQLException
- if an error occurs while attempting to
access the arraypublic java.sql.ResultSet getResultSet(java.util.Map map) throws java.sql.SQLException
ARRAY
value
designated by this Array
object.
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. This version of the method
getResultSet
uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.
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.
getResultSet
in interface java.sql.Array
map
- contains the mapping of SQL user-defined types to
classes in the Java programming languageResultSet
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.java.sql.SQLException
- if an error occurs while attempting to
access the arraypublic java.sql.ResultSet getResultSet(long index, int count) throws java.sql.SQLException
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 stores the index into the
array for that element.
getResultSet
in interface java.sql.Array
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 retrieveResultSet
object containing up to
count
consecutive elements of the SQL array
designated by this Array
object, starting at
index index
.java.sql.SQLException
- if an error occurs while attempting to
access the arraypublic java.sql.ResultSet getResultSet(long index, int count, java.util.Map map) throws java.sql.SQLException
index
and contains up to
count
successive elements.
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. This version of the method
getResultSet
uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.
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.
getResultSet
in interface java.sql.Array
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 languageResultSet
object containing up to
count
consecutive elements of the SQL array
designated by this Array
object, starting at
index index
.java.sql.SQLException
- if an error occurs while attempting to
access the arraypublic void free() throws java.sql.SQLException
Array
object and releases the resources that
it holds. The object is invalid once the free
method is called.
After free
has been called, any attempt to invoke a
method other than free
will result in a SQLException
being thrown. If free
is called multiple times, the subsequent
calls to free
are treated as a no-op.
free
in interface java.sql.Array
java.sql.SQLException
- if an error occurs releasing
the Array's resourcesjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodCopyright © 2001-2019 Jaybird (Firebird JDBC/JCA) team. All rights reserved.