Anyframe Query Manager

편리한 Query문 관리를 도와주는 각종 View 및 Context Menu 등을 포함하는 Query Manager Perspective 제공

Anyframe의 Query Service를 통해 활용하는 다양한 Query문에 대한 생명주기관리(Life-Cycle Management) 지원

Anyframe Query Manager는 Eclipse Update Site와, Anyframe Portal에 압축 파일로 각각 배포하고 있다.

Your original request has been modified.
  "Anyframe Query Manager" is already installed, so an update will be performed instead.
Cannot complete the install because of a conflicting dependency.
  Software being installed: Anyframe Query Manager 2.1.7 (anyframe.querymanager.eclipse.core.feature.group 2.1.7)
  Software currently installed: Anyframe Common 3.1.0 (anyframe.common.eclipse.core.feature.group 3.1.0)
  Only one of the following can be installed at once: 
    Anyframe Common 3.1.0 (anyframe.common.eclipse.core 3.1.0)
    Anyframe Common 3.1.1 (anyframe.common.eclipse.core 3.1.1)
  ...

Anyframe Query Manager 2.0.0 버전을 포함한 하위 버전에서 2.1.0 이상 버전으로 업그레이드를 할 경우에는 다음과 같은 순서를 따른다.

Connections View는 사용자가 DBMS의 특정 데이터베이스에 연결할 수 있는 커넥션 프로파일을 생성할 수 있게 하며, 해당 커넥션을 생성하고 관리할 수 있게 한다. 새 로운 커넥션 프로파일을 생성하려면 Connections View에서 Context Menu를 통해 "New Connection Profile..."을 선택한 후, 필요한 정보를 입력한다. 사용자의 환경에 따라 Eclipse 환경설정에서 JDBC 드라이버를 설정("Preferences > SQL Explorer > JDBC Drivers")할 필요가 있을 수 있다.

또한, 사용자는 Query 맵핑 XML 파일에 실제 Query를 작성하기 전에, SQL Editor를 통하여 해당 Query를 테스트할 수 있다. SQL Editor는 데이터베이스 커넥션이 생성될 때 자동으로 열리며, SQL Editor를 닫았거나 추가적으로 더 열려면 해당 커넥션에 대한 Context Menu에서 "New SQL Editor"를 선택한다.

Database Structure View는 사용자가 연결한 데이터베이스 커넥션에 대한 데이터베이스의 구조를 트리 형태로 보여준다.

Anyframe Query Manager는 Database Structure View에서 Table Mapping 정보를 생성할 수 있는 방법을 제공하며, 해당 기능은 Database Structure View에서 원하는 테이블을 찾아 Context Menu의 "Generate Table Mapping"을 선택함으로써 실행시킬 수 있다.

Query Manager는 Property 셋팅을 통해 Query ID를 관리하고자 하는 Query 맵핑 파일을 추가할 수 있다. 여기에 추가한 XML 파일내에 있는 ID들만이 앞으로 나올 Query Explorer View에서 나타난다.

또한 Query ID의 사용 여부, 중복 여부를 보여주는 설정이 가능하며 Query ID를 새로 생성할 때 Query에 대한 정보를 주석으로 남길 것인지에 대한 설정 역시 가능하다.

XML 파일을 추가하는 방법은, 프로젝트 내의 경로를 찾아가 추가하는 방법과, 관리 대상이 될 수 있는 XML 파일들 중에 고르는 방법 두가지가 있다.

Add

Query ID가 포함된 Query 맵핑 xml 파일들을 트리 형태로 보여준다.

Scan

Query ID가 포함된 Query 맵핑 xml 파일들을 선택할 수 있게 보여준다.

Query Explorer View는 프로젝트 별로 설정된 Query 맵핑 XML의 Outline 및 Query ID의 사용여부, 중복 여부를 설정된 아이콘을 통해 쉽게 파악하는 기능을 제공한다.

Query Explorer View는 Anyframe Query Manager Perspective를 열면 자동으로 뜨며, 다음과 같은 방법으로도 열 수 있다.

Query Explorer View는 다음과 같은 요소들로 구성되어 있다.

Query Results View는 Query Test Editor를 통한 Query 작성 시 수행한 Query 테스트의 결과를 표시하는 기능을 제공한다. Query Results View는 다음과 같은 방법으로 열 수 있다.

Query Results View는 Query Test Editor를 통한 Query 작성 시 수행하는 Query 테스트 결과가 표시되므로, 미리 그 결과에 대해 확인하고 쿼리문을 수정할 수 있다

Query Test Editor는 Query Explorer View를 통해 열 수 있다.

Add Query Editor

Query ID는 해당 맵핑 파일의 Context 메뉴를 통해 추가할 수 있다.

사용 방법에 대해서는 Adding a Query에 자세히 나타나있다.

Edit Query Editor

해당 Query ID의 Context 메뉴를 통해 Query 정보를 수정할 수 있다.

사용 방법에 대해서는 Modifying a Query에 자세히 나타나있다.

Query Test Editor를 통한 Query문 작성은 데이터베이스/테이블/컬럼 등의 정보를 GUI를 통해 마우스 조작으로 입력할 수 있고, 작성하고 있는 Query문을 Query Test Editor를 종료하지 않고서도 테스트해 볼 수 있는 장점이 있다.

Query Test Editor를 활용하여 Query문을 작성하는 절차는 다음과 같다.

비록 GUI 환경의 이점을 살릴 수는 없지만, 숙달된 사용자나 재사용할 수 있는 Query문이 어느정도 이상 축적되었을 경우에는 Query Manager Editor를 활용한 Query문의 직접 작성이 작업의 효율을 더욱 높일 수 있다. 또한, Query Manager Editor는 Content Assist를 통해 Query 맵핑 XML의 DTD에 정의된 각종 태그 및 어트리뷰트 등을 제공하므로, 기존 Query문에 대한 손쉬운 응용 및 개선이 가능하다.

Query 맵핑 XML의 구조, 각 태그 및 어트리뷰트에 대한 상세설명은 Anyframe매뉴얼의 Query Service 부분을 참고한다.

Query Test Editor를 통한 Query문 수정은 Query Explorer View에서 Query ID의 Context Menu를 통해 실행한다. 실행된 Query Test Editor에서 Query문을 수정할 때에는 Query Test Editor를 활용한 Query문 추가 와 동일한 방법을 따른다.

Query Manager Editor를 통한 Query문 수정은 기존의 Query문을 편집한다는 점만 제외하고는 새로운 Query문을 추가하는 것과 동일한 방법을 따른다. 보다 자세한 사항은 Query Manager Editor를 활용한 Query문 추가 를 참고한다.

Query Explorer를 통해서 Query문을 삭제하고자 할 때에는 Query Explorer View에서 해당 Query ID를 선택하고, Context Menu의 "Remove Query"를 실행한다.

Context Menu를 통해서 Query문을 삭제하고자 할 때에는 Query Manager Editor의 Design탭에서 해당 Query를 선택하고, Context Menu의 "Remove"를 실행한다.

Query문을 직접 삭제하고자 할 때에는 Query Manager Editor의 Source 탭에서 해당하는 Query를 선택한 후 삭제한다. 이때, 선택할 범위는 삭제하고자 하는 Query문이 포함된 <query>와 </query> 로 묶인 범위이다.

Content Assist의 환경설정은 Eclipse Preferences의 "Java > Editor > Content Assist > Advanced"에서 설정하며, Anyframe Query Manager의 Content Assist가 단축키의 호출대상이 될 지의 여부를 정한다.

Eclipse Java Editor에서 Anyframe의 Query Service를 활용한 DAO(IQueryService를 활용하거나 AbstractDAO를 상속받았을 때)에 대하여 Content Assist가 Query ID에 대한 후보목록을 보여준다. 이 기능은 Query Service의 메소드가 인자로 받는 Query ID(String 타입으로 " "로 묶인 부분) 입력부분에서 키보드 단축키를 통해 Content Assist를 호출했을 때 제공된다.

Anyframe Query Manager의 Query Manager Editor의 Source 탭에서 Query 편집 시Query 맵핑 XML의 태그 및 어트리뷰트에 대한 후보목록을 보여준다.

Query와 Java 코드 간 네비게이션이 가능하며, 이는 다음과 같은 두가지 경우를 지원한다.

DAO에서 사용하는 특정 Query문의 내용을 확인하고 싶을 때, Query 맵핑 XML 파일이 너무 많거나 Query문이 너무 많다면 해당 Query문이 어디에 있는 지 알기 어려울 수 있다. 이를 위해 Anyframe Query Manager는 Context Menu를 통해서 해당 Query문을 바로 열 수 있는 기능을 제공한다.

본 기능을 활용하는 방법은 다음과 같다.

Query문에서 사용하는 Query가 어떤 DAO에서 사용되는지 확인하고 싶을 때, 해당 DAO를 찾아가기 번거로울 수 있다. 이를 위해 Anyframe Query Manager는 Context Menu를 통해서 해당 DAO를 바로 열 수 있는 기능을 제공한다.

본 기능을 활용하는 방법은 다음과 같다.

Anyframe Query Manager Nature를 특정 Java 프로젝트에 적용하기 위해서는 해당 프로젝트의 Context Menu에서 "Anyframe Query Manager > Add Anyframe Query Manager Nature"를 선택한다. Anyframe Query Manager Nature가 활성화되어 적용되면, "Anyframe Builder"의 기능이 해당 프로젝트에 적용된다. 이미 적용한 Anyframe Query Manager Nature를 해제하기 위해서는 Context Menu에서 "Anyframe Query Manager > Remove Anyframe Query Manager Nature"를 선택한다.

Anyframe Query Manager Nature 가 해당 프로젝트에 대하여 적용(활성화; "Context Menu: Anyframe Query Manager > Add Anyframe Query Manager Nature")되었을 경우, 다음과 같은 조건을 만족할 때 Anyframe Builder의 작업이 수행된다.

위의 모든 경우에 대하여 "리소스"는 Query 맵핑 XML 파일을 의미하며, 표시된 오류나 경고에 대해서는 사용자가 직접 문제점을 해결하기 전까지는 해당 표식은 사라지지 않는다.