java.sql
인터페이스 SQLData

public interface SQLData

SQL 사용자 정의형 (UDT)을 Java 프로그램 언어의 클래스에 커스텀 매핑 하는데 사용되는 인터페이스입니다. SQLData인터페이스를 구현하는 클래스의 클래스 객체는 커스텀 매핑 되는 UDT SQL 명과 함께 적절한 Connection 객체의 형태 맵에 입력됩니다.

보통 SQLData 구현은 SQL 구조화형의 각 속성의 필드, 또는 SQL DISTINCT 형의 단일 필드를 정의합니다. ResultSet.getObject 메서드에 의해 데이터 소스로부터 UDT가 취득되면, 그 UDT는 이 클래스의 인스턴스로서 매핑 됩니다. 프로그래머는 Java 프로그램 언어의 다른 객체의 경우와 같이 이 클래스 인스턴스로 조작해, PreparedStatement.setObject 메서드를 호출해, 행한 변경을 이 클래스 인스턴스에 보존할 수 있습니다 . PreparedStatement.setObject 메서드는 반대로 그 클래스 인스턴스를 SQL 형에 매핑 합니다.

커스텀 매핑의 클래스의 구현을 툴에 의해 실시하는 것이 기대할 수 있습니다. 보통 의 구현에서는 프로그래머는 단지 SQL UDT 이름, 그 이름이 매핑 되는 클래스의 이름 및 UDT 각 속성이 매핑 되는 필드의 이름을 지정할 뿐입니다. 툴은 이 정보를 사용해 SQLData.readSQL 메서드 및 SQLData.writeSQL 메서드를 구현합니다. readSQL 메서드가 해당의 SQLInput 메서드를 호출해 SQLInput 객체로부터 각 속성을 읽기, writeSQL 메서드가 SQLOutput 메서드를 호출해 SQLOutput 객체를 사용해 각 속성을 데이터 소스에 출력합니다.

보통 어플리케이션 프로그래머가 SQLData를 직접 호출할 것은 없고, SQLInput 메서드 및 SQLOutput 메서드는 어플리케이션 코드 에 해서가 아니라 SQLData 메서드에 의해 내부에서 호출합니다.

도입된 버전 :

1.2

메서드 개요

String	getSQLTypeName () 이 객체가 나타내는 SQL 사용자 정의형의 완전 지정명을 리턴합니다.
void	readSQL (SQLInput stream, String typeName) 데이타베이스로부터 읽어낸 데이터를 이 객체로 설정합니다.
void	writeSQL (SQLOutput stream) 이 객체를 데이터 소스의 SQL 치로 변환해, 지정된 SQL 데이터 스트림에 출력합니다.

메서드의 상세

getSQLTypeName

String  getSQLTypeName()
                      throws SQLException 

이 객체가 나타내는 SQL 사용자 정의형의 완전 지정명을 리턴합니다. 이 메서드는 SQLData 이 인스턴스에 매핑 되는 UDT 인스턴스의 이름을 취득하기 위해서 JDBC 드라이버에 의해 호출합니다.

반환값:

이 객체가 생성되어 값이 설정되었을 때에 readSql 메서드에게 건네진 형명

예외:

SQLException - 데이타베이스 액세스 에러가 있는 경우

도입된 버전 :

1.2

readSQL

void readSQL(SQLInput  stream,
             String  typeName)
             throws SQLException 

데이타베이스로부터 읽어낸 데이터를 이 객체로 설정합니다. 이 메서드의 구현은 다음의 프로토콜에 따를 필요가 있습니다.

• 지정된 입력 스트림로부터 SQL 형의 각 속성 또는 각 요소를 읽어낼 필요가 있습니다. 이것은 형태의 SQL 정의에 나타나는 순서로 입력 스트림의 메서드를 호출해 각 항목을 읽어내는 것에 의해 행해집니다.
• 계속되어 메서드 readSQL가 이 객체 또는 다른 객체의 적절한 필드 또는 요소에 데이터를 할당합니다. 구체적으로는 해당하는 reader 메서드 (SQLInput.readString, SQLInput.readBigDecimal 등)를 호출해 다음의 처리를 실시할 필요가 있습니다. 개별의 형태의 경우는 그 단일의 데이터 요소를 읽기, 구조화형의 경우는 SQL 형의 각 속성의 값을 읽어들입니다.

JDBC 드라이버는 형태 맵을 사용해 입력 스트림을 초기화하고 나서, 스트림로 대응하는 SQLInput reader 메서드에 의해 사용되는 이 메서드를 호출합니다.

파라미터:

stream - 커스텀 매핑 되는 데이터의 값을 읽어내는 SQLInput 객체

typeName - 데이터 스트림의 값의 SQL 형명

예외:

SQLException - 데이타베이스 액세스 에러가 있는 경우

관련 항목:

SQLInput

writeSQL

void writeSQL(SQLOutput  stream)
              throws SQLException 

이 객체를 데이터 소스의 SQL 치로 변환해, 지정된 SQL 데이터 스트림에 출력합니다. 이 메서드의 구현은 이 프로토콜에 따를 필요가 있습니다.
지정된 출력 스트림에 SQL 형의 각 속성을 출력할 필요가 있습니다. 이것은 형태의 SQL 정의에 표시되는 차례로 출력 스트림의 메서드를 호출해 각 항목을 출력하는 것에 의해 행해집니다. 구체적으로는 해당하는 SQLOutput writer 메서드 (writeInt, writeString 등)를 호출해 다음의 처리를 실시할 필요가 있습니다. 개별의 형태의 경우는 단일의 데이터 요소를 출력해, 구조화형의 경우는 SQL 형의 각 속성의 값을 출력합니다.

파라미터:

stream - 커스텀 매핑 된 데이터의 값을 출력하는 SQLOutput 객체

예외:

SQLException - 데이타베이스 액세스 에러가 있는 경우

도입된 버전 :

1.2

관련 항목:

SQLOutput