org.firebirdsql.jdbc.FBArray Maven / Gradle / Ivy
Show all versions of jaybird-jdk15 Show documentation
/*
* Firebird Open Source J2ee connector - jdbc driver
*
* Distributable under LGPL license.
* You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* LGPL License for more details.
*
* This file was created by members of the firebird development team.
* All individual contributions remain the Copyright (C) of those
* individuals. Contributors to this file are either listed here or
* can be obtained from a CVS history command.
*
* All rights reserved.
*/
package org.firebirdsql.jdbc;
import java.sql.*;
import java.util.Map;
/**
* A Firebird-specific implementation of the mapping of a java.sql.Array.
*
* @author David Jencks
* @see java.sql.Array
* @version 1.0
*/
public class FBArray implements Array {
/**
* 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.
* @return 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 UDT
* @exception SQLException if an error occurs while attempting
* to access the type name
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public String getBaseTypeName() throws SQLException {
return null;
}
/**
* Returns the JDBC type of the elements in the array designated
* by this Array object.
* @return a constant from the class {@link java.sql.Types} that is
* the type code for the elements in the array designated by this
* Array object.
* @exception SQLException if an error occurs while attempting
* to access the base type
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public int getBaseType() throws SQLException {
throw new FBDriverNotCapableException();
}
/**
* Retrieves the contents of the SQL 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.
* @return an array in the Java programming language that contains
* the ordered elements of the SQL ARRAY value
* designated by this object
* @exception SQLException if an error occurs while attempting to
* access the array
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public Object getArray() throws SQLException {
return null;
}
/**
* Retrieves the contents of the SQL array 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
* getArray uses either the given type map or the standard mapping;
* it never uses the type map associated with the connection.
*
* @param map a java.util.Map object that contains mappings
* of SQL type names to classes in the Java programming language
* @return an array in the Java programming language that contains the ordered
* elements of the SQL array designated by this object
* @exception SQLException if an error occurs while attempting to
* access the array
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public Object getArray(Map map) throws SQLException {
return null;
}
/**
* 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. This method uses the type map
* associated with the connection for customizations of the type mappings.
* @param index the array index of the first element to retrieve;
* the first element is at index 1
* @param count the number of successive SQL array elements to retrieve
* @return an array containing up to count consecutive elements
* of the SQL array, beginning with element index
* @exception SQLException if an error occurs while attempting to
* access the array
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public Object getArray(long index, int count) throws SQLException {
return null;
}
/**
* 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.
*
* 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.
*
* @param index the array index of the first element to retrieve;
* the first element is at index 1
* @param count the number of successive SQL array elements to
* retrieve
* @param map a java.util.Map object
* that contains SQL type names and the classes in
* the Java programming language to which they are mapped
* @return an array containing up to count
* consecutive elements of the SQL array designated by this
* Array object, beginning with element
* index.
* @exception SQLException if an error occurs while attempting to
* access the array
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public Object getArray(long index, int count, Map map)
throws SQLException {
return null;
}
/**
* Returns a result set that contains the elements of the SQL
* 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.
* @return a {@link 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.
* @exception SQLException if an error occurs while attempting to
* access the array
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public ResultSet getResultSet () throws SQLException {
return null;
}
/**
* Returns a result set that contains the elements of the SQL
* 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.
* @param map contains the mapping of SQL user-defined types to
* classes in the Java programming language
* @return 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.
* @exception SQLException if an error occurs while attempting to
* access the array
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public ResultSet getResultSet (Map map) throws SQLException {
return null;
}
/**
* 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 stores the index into the
* array for that element.
* @param index the array index of the first element to retrieve;
* the first element is at index 1
* @param count the number of successive SQL array elements to retrieve
* @return a ResultSet object containing up to
* count consecutive elements of the SQL array
* designated by this Array object, starting at
* index index.
* @exception SQLException if an error occurs while attempting to
* access the array
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*/
public ResultSet getResultSet(long index, int count) throws SQLException {
return null;
}
/**
* 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 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.
* @param index the array index of the first element to retrieve;
* the first element is at index 1
* @param count the number of successive SQL array elements to retrieve
* @param map the Map object that contains the mapping
* of SQL type names to classes in the Java(tm) programming language
* @return a ResultSet object containing up to
* count consecutive elements of the SQL array
* designated by this Array object, starting at
* index index.
* @exception SQLException if an error occurs while attempting to
* access the array
* @since 1.2
* @see What Is in the JDBC
* 2.0 API
*
*/
public ResultSet getResultSet (long index, int count, Map map)
throws SQLException {
return null;
}
/**
* This method frees the 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.
*
*
* @throws SQLException if an error occurs releasing
* the Array's resources
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
public void free() throws SQLException {
}
}