====== SqlMap Config Editor ======
===== 개요 ======
SqlMap Config Editor 는 SQL Maps 설정 파일을 편리하게 작성할 수 있도록 도와주는 개발도구이다. 
SqlMap Config Editor 는 Transaction Manager 와 SqlMap 목록으로 구성되어 있으며, 
주요 기능은 다음과 같다. 

  * Transacation Manager 편집 기능이다.
  * SqlMap 목록 편집 기능이다.


{{:egovframework:sqlmapconfig1-1.jpg}}
\\ <sup> <그림 1> SqlMap Config Editor </sup>

===== 설명 ======

==== Transaction Manager ====

SqlMap Config Editor 는 주요 트랜잭션 Type과 DataSource Type 에 필요한 Properties 항목을 사전 정의해 놓았기 때문에 개발자가 간단한 선택작업과 입력작업만으로도 Transaction Manager 를 설정할 수 있다. 기존 정의된  Properties 항목 외에도 사용자 정의 항목 추가 기능을 통해 Property 항목을 추가할 수 있다. 

Transaction Manager 의 설정항목은 Type, DataSource Type, Properties 이며, 세부사항은 다음과 같다. 

=== Type ===

Transaction Manager 의 type 속성은 어떤 트랜잭션 관리자를 사용할지를 결정하는 것이다. 

^ 이름        ^ 설명        ^ 
| JDBC    | 간단한 JDBC 기반 트랜잭션 관리 기능을 제공한다. |
| JTA    | 컨테이너에 기반한 트랜잭션 관리 기능을 애플리케이션에 제공한다. | 

=== DataSource Type ===

Transaction Manager 의 DataSource Type 속성은 프레임워크가 어떤 클래스의 객체를 생성해서 데이터 소스 팩토리를 얻어올지 정하는 type 속성을 가지고 있다. 

^ 이름        ^ 설명        ^ 
| SIMPLE    | Simple 데이타 소스 팩토리는 간단한 커넥션 풀을 내장한 데이터 소스를 설정하고자 할 때 이를 사용하며, eGovFrame 이 사용하고 있는 iBatis 프레임워크는 실제 JDBC 드라이버를 제외하고 데이터 소스에 필요한 모든 것을 자체 내장하고 있다. |
| JNDI    | JNDI 데이터 소스 팩토리는 JNDI 를 통해 할당된 컨테이너 기반의 데이터 소스를 공유하도록 사용된다. | 

=== Properties ===

Transaction Manager 의 Properties 속성은 설정을 좀 더 일반화하기 위해서 이름/값 쌍의 리스트를 제공한다. 
DataSource Type 속성에 따른 기본 Properties 항목은 다음과 같다. 

^ DataSource Type        ^ 기본 Properties 항목        ^ 
| JDBC - SIMPLE | JDBC.Driver |
| | JDBC.ConnectionURL |
| | JDBC.Username |
| | JDBC.Password |
| JDBC/JTA - JNDI | DataSource | 

기본 Properties 항목 외에 필요한 Property 를 추가, 수정, 삭제할 수 있다. 

== Add ==
사용자가 필요한 Property 를 추가한다. 

== Remove ==
Properties 항목 중에 불필요한 항목을 선택하여 Property 를 제거한다. 

== Init ==
Properties 항목을 DataSource Type 속성에 정의한 기본Properties 항목으로 모두 초기화한다. 



==== SqlMap 목록 ====

SqlMap 목록에서는 사용할 SQLMaps 맵핑 파일을 지정한다. 

== Add ==
SQLMaps 맵핑 파일을 추가한다. 

== Remove ==
SqlMap 목록 중에서 불필요한 SQLMaps 맵핑 파일을 선택하여 제거한다. 
단, SqlMap 목록에서 제거될 뿐, 실제 파일이 삭제되는 것은 아니다. 

== New ==
SQLMaps 맵핑 파일을 새로 생성하는 동시에 SqlMap 목록 중에 새로 생성된 SQLMaps 맵핑 파일을 추가한다.

===== 사용법 ======

==== SQL Map Config File 새로 만들기 ===

  - 상단 메뉴의 (("eGovFrame" 메뉴는 eGovFrame Perspective 환경에서만 나타난다.)) eGovFrame -> Implementation -> New SQL Map Config 또는 Context Menu의 New -> sqlMapConfig 를 통해 파일을 생성한다.\\ {{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig-new.png|}}\\ <sup> <그림 2> sqlMapConfig 생성방법 1 </sup>\\ \\ {{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig-new2.png|}}\\ <sup> <그림 3> sqlMapConfig 생성방법 2 </sup> \\ \\
  - SqlMapConfig 파일이 위치할 폴더를 선택하고 파일명을 입력한다.(<그림 4> 참조) \\ \\

==== SQL Map Config Editor 열기 ==== 

Package Explorer 에서 해당 SQL Map Config File을 선택하고 더블클릭하거나 열기를 누르면 자동으로 SQL Map Config Editor 로 열리게 된다.

{{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig1-2.png|}}
\\ <sup> <그림 4> SQL Map Config File의 선택 </sup> 


단, SQL Map Config file에 이상이 있거나, 다른 이유로 SQL Map Config Editor 로 열리지 않을 때에는 context menu 의 open with 기능을 사용하여 editor 를  SQL Map Config Editor 로 선택해야 한다. (<그림 5> 참조)

{{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig1-3.png|}}
\\ <sup> <그림 5> SQL Map Config Editor 로 자동으로 열리지 않을 경우  </sup> 
 

==== Transaction Manager 사용법 ==== 
  - SQL Map Config Editor에서 "Transaction Manager" 타이틀을 클릭하면 "Transaction Manager" Tab 이 확장되면서 편집가능한 상태가 된다. 
  - 사용자 프로젝트에 적합한 Type 을 선택한다. 
  - 사용자 프로젝트에 적합한 DataSource Type 을 선택한다. 사용자가 DataSource Type 을 선택하면 적절한 기본 Properties 항목이 자동으로 보여진다. (<그림6> 참조)
  - Properties 항목에 적절한 값을 입력한다. 
  - 필요한 경우, Properties 항목을 추가 또는 삭제하려면 Properties 목록 우측에 있는 "Add", "Remove" 버튼을 활용한다. DataSource Type 을 다시 선택한 경우에는 "Init" 버튼을 눌러 Properties 항목을 재입력한다. 

{{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig1-4.jpg|}}
\\ <sup> <그림 6> Transaction Manager  </sup> 


==== SQL Map 목록 사용법 ==== 

{{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig1-5.jpg|}}
\\ <sup> <그림 7> SQL Map 목록 </sup> 


  - SQL Map 목록 우측에 있는 "add" 버튼을 클릭하여 SQL Map 파일을 검색하고 하나 이상의 SQL Map 파일을 선택하여 추가할 수 있다. (<그림 8> 참조)
  - SQL Map 목록에 불필요한 SQL Map 파일이 있는 경우 해당항목을 선택하고 "Remove" 버튼을 클릭하여 선택된 항목을 제거한다. 단, 실제 파일이 삭제되는 것은 아니다. 
  - 사용할 SQL Map 파일이 존재하지 않는 경우 "New" 버튼을 클릭하여 새 SQL Map 파일을 생성함과 동시에 새로 생성된 SQL Map 파일을 목록에 추가할 수 있다. (<그림 9> 참조)
  - SQL Map 목록의 항목이 하나이상인 경우  SQL Map 목록 바로 위에 있는 filter 를 사용하여 SQL Map 파일 항목을 선택적으로 조회할 수 있다. (<그림 10> 참조)
 

{{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig1-6.jpg|}}
\\ <sup> <그림 8> SQL Map 파일 검색   </sup> 


{{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig1-7.jpg|}}
\\ <sup> <그림 9> SQL Map 파일 신규 생성 화면  </sup> 


{{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig1-8.jpg|}}
\\ <sup> <그림 10> SQL Map 목록의 filter 적용  </sup> 


==== SQL Map Config File의 소스 직접 수정하기 ==== 

  - SQL Map Config Editor 에는 Form UI 를 사용하지 않고 XML 을 직접 수정할 수 있는 기능을 제공하고 있다. 
  - SQL Map Config Editor 에서 편집화면 하단에 보이는 "파일명.xml" 이라는 제목의 Tab 을 클릭하면 Form UI를 사용하지 않고 XML Source 를 직접 수정할 수 있다. (<그림 11> 참조)


{{:egovframework:dev2:imp:editor:dbio_editor:sqlmapconfig1-9.jpg|}}
\\ <sup> <그림 11> SQL Map Config 파일 직접 수정  </sup>