====== XFrame5Util API Reference ====== ==== XFrame5Util 개요 ==== === Methods === ^ 이름 ^ 설명 ^ | xFrame5Map | 화면에서 송신된 request의 파라미터값들을 변환하여 Map으로 반환한다. | | printMetaInfoMap | xFrame5Map API로 생성한 Map에서 화면 메타 정보를 로그로 출력한다. | | getDataMap (getRecordFromMap) | xFrame5Map API로 생성한 Map에서 지정한 DATASET의 레코드를 Map 형태로 반환한다. | | getDataMapList (getRecordListFromMap) | xFrame5Map API로 생성한 Map에서 지정한 DATASET을 Map리스트 형태로 반환한다. | | getDataBean (getBeanFromMap) | xFrame5Map API로 생성한 Map에서 지정한 DATASET의 레코드를 Bean 형태로 반환한다. | | getDataBeanList (getBeanListFromMap) | xFrame5Map API로 생성한 Map에서 지정한 DATASET을 Bean리스트 형태로 반환한다. | | getDataString (getDataFromMap) | xFrame5Map API로 생성한 Map에서 지정한 데이터를 문자열로 반환한다. | | setOutputData | ModelMap에 정의된 출력 속성 객체에 데이터를 삽입한다. | | getCountFromMap | xFrame5Map API로 생성한 Map에서 지정한 DATASET의 레코드 수를 반환한다. | | isDeleteRecord | xFrame5Map API로 생성한 Map에서 지정한 DATASET의 레코드가 삭제된 레코드인지를 판단한다. | | isInsertRecord | xFrame5Map API로 생성한 Map에서 지정한 DATASET의 레코드가 추가된 레코드인지를 판단한다. | | isUpdateRecord | xFrame5Map API로 생성한 Map에서 지정한 DATASET의 레코드가 변경된 레코드인지를 판단한다. | xframe5util 을 사용하기 위해서는 xframe5View 와 beanNameViewResolver 가 선언되어 있어야 한다. () 안에 Method 는 @Deprecated 를 의미하며 code refactoring 이유로 제거 될 예정이다. ==== XFrame5Util API 설명 ==== ==== xFrame5Map ==== === Prototype === Map xFrame5Map(HttpServletRequest request, HttpServletResponse response, ModelMapmodel); === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | HttpServletRequest | request | 데이터 셋 객체를 생성하기 위한 request | | HttpServletResponse | response | 데이터 셋 객체를 생성하기 위한 response | | ModelMap | model | Springframework의 ModelMap객체 | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Map | map | XFrame5Util에서 사용되는 데이터셋 정보 | === Description === XFrame5 화면과 서버와의 통신시 request 의 파라미터에 데이터 셋, 글로벌 데이터 셋, 화면 메타 정보등이 담겨 송신된다(데이터셋에 담기는 데이터 항목에 대한 자세한 설명은 xDataSet5 DevGuide 문서 참고) xFrame5Map API 에서는 request, response 를 사용하여 xDataSet5 객체를 생성하며 이를 Map 형식으로 사용하기 위해 Map>>형태로 변환하여 반환한다. 반환값인 맵에 포함되는 데이터는 아래와 같다. -데이터셋 오브젝트: XFrame5View.XFRAME5_XDATASET5, xDataSet5 오브젝트 -파라미터 데이터: 파라미터네임, 파라미터값(xTranMap Url 의 지정한 파라미터 데이터) -데이터셋 데이터: 데이터셋이름, 데이터셋 데이터\\ 데이터셋 데이터 구조: 데이터셋 레코드 데이터 리스트\\ 데이터셋 레코드 데이터 구조: 맵<데이터셋 칼럼 이름(문자열), 데이터셋 칼럼 값(문자열)> === Sample === Map reqMap = XFrame5Util.xFrame5Map(request, response, model); === See Also === ==== printMetaInfoMap ==== === Prototype === void printMetaInfoMap(Map xf5Map); === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Map | xf5Map | XFrame5Util에서 사용되는 데이터형 Map 객체 | === Return Value === 해당없음. === Description === xframe5Map API 를 사용해 생성된 Map 객체에는 화면 메타 정보가 포함되어 있으며 화면 메타 정보에는 화면 경로 및 이름, 사용자 시스템 IP 주소, 트랜잭션 맵 ID 등의 정보가 포함되어 있다. printMetaInfoMap API 는 화면 메타 정보를 로그로 출력 하는 기능을 하며, apache 에서 제공하는 LogFactory 클래스를 사용하여 info 로그레벨로 출력한다. === Sample === Map reqMap = XFrame5Util.xFrame5Map(request, response, model); XFrame5Util.printMetaInfoMap(reqMap); === See Also === ==== getDataMapList ==== === Prototype === List> getDataMapList(Map inputDataMap, String datasetName); === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Map | inputDataMap | XFrame5Util에서 사용되는 데이터형 Map객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | List | recordList | 구해진 리스트 데이터 | === Description === XFrame5Map API 의 반환값인 Map 객체에는 화면에서 정의한 입력데이터셋의 값이 Map형식으로 포함되어 있다. getDataMapList API 를 사용하여 지정한 키값의 List 를 반환할 수 있다. 반환된 List 는 Map로 구성된다. === Sample === Map reqMap = XFrame5Util.xFrame5Map(request, response, model); List> recordList = XFrame5Util.getDataMapList(reqMap, "ds_input"); === See Also === getDataMap ==== getDataMap ==== === Prototype === Map getDataMap(Map inputDataMap, String datasetName, intnRecordIndex); === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Map | inputDataMap | XFrame5Util에서 사용되는 데이터형 Map 객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | | int | nRecordIndex | 데이터 셋 이름으로 구해진 List에서 반환 시킬 레코드 순서 | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Map | recordMap | 구해진 레코드 데이터 | === Description === xFrame5Map API 를 사용하여 반환된 Map 은 Map>>형식을 이루게 된다. getDataMap API 는 입력 데이터셋에 해당하는 List 값에서 레코드 인덱스 파라미터에 해당하는 Map값을 반환한다 === Sample === MMap reqMap = XFrame5Util.xFrame5Map(request, response, model); List> empInfoList = xFrame5Service.selectDataConvList(XFrame5Util.getDataMap( reqMap, "ds_input", 0)); === See Also === getDataMapList ==== getDataBean ==== === Prototype === Object getDataBean(Map inputDataMap, String datasetName, int nRecordIndex, String beanClassName); === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Map | inputDataMap | XFrame5Util에서 사용되는 데이터형 Map 객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | | int | nRecordIndex | 데이터 셋 이름으로 구해진 List에서 반환 시킬 레코드 순서 | | String | beanClassName | 변환시킬 VO형 Class Name | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Object | recordList | 구해진 레코드 데이터 Object | === Description === xFrame5Map API 를 사용하여 반환된 Map 은 Map>>형식을 이루게 된다. getDataBean API 는 입력 데이터셋에 해당하는 List 값에서 레코드 인덱스 파라미터에 해당하는 레코드를 지정한 Object 형으로 반환한다. === Sample === Map reqMap = XFrame5Util.xFrame5Map(request, response, model); ExampleVO exampleVO = (ExampleVO) XFrame5Util.getDataBean(reqMap, "DS_REQ", 0, ExampleVO.class.getName()); List empVOList = (List)exampleService.selectVOListByVO(exampleVO); === See Also === getDataBeanList ==== getDataBeanList ==== === Prototype === List getDataBeanList(Map inputDataMap, String datasetName, int nRecordIndex, String beanClassName); === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Map | inputDataMap | XFrame5Util에서 사용되는 데이터형 Map 객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | | int | nRecordIndex | 데이터 셋 이름으로 구해진 List에서 반환 시킬 레코드 순서 | | String | beanClassName | 사용할 VO의 클래스 이름 | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | List | recordDataBean | 구해진 레코드 데이터 Object List | === Description === xFrame5Map API 를 사용하여 반환된 Map 은 Map>>형식을 이루게 된다. getRecordFromBean API 는 입력데이터셋에 해당하는 List 값에서 레코드 인덱스 파라미터에 해당하는 Map값을 beanClassName 이름에 해당하는 VO List 형으로 변환하여 반환한다. === Sample === Map reqMap = XFrame5Util. xFrame5Map(request, response, model); String className = "egovframework.example.sample.service.vo.EmpInfoVO"; List empVo = XFrame5Util.getDataBeanList(reqMap, "ds_input", 0, className); === See Also === getDataBean ==== getDataString ==== === Prototype === String getDataString(Map inputDataMap, String datasetName, int nRecordIndex, String columnName, String defaultValue); === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | Map | inputDataMap | XFrame5Util에서 사용되는 데이터형 Map 객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | | int | nRecordIndex | 데이터 셋 이름으로 구해진 List에서 반환 시킬 레코드 순서 | | String | columnName | 화면에서 정의한 데이터 셋의 컬럼 이름 | | String | defaultValue | 데이터가 없을 시 기본값(옵션) | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | String | resultData | 구해진 데이터 | === Description === getDataString API 는 입력데이터셋에 해당하는 List 값에서 하나의 데이터 값만을 반환할 때 사용하는 API 이다. getDataMap API 가 Map형태로 반환하게 되는데, getDataString API 는 여기에 칼럼이름을 파라미터로 전달하여 하나의 값을 String 타입으로 반환하게 된다. === Sample === Map reqMap = XFrame5Util.xFrame5Map(request, response, model); String temp_emp_age = XFrame5Util.getDataString(reqMap, "ds_input", 0, "emp_age", "0"); === See Also === ==== setOutputData ==== === Prototype === void setOutputData(Map model, String key, List> listData); === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | ModelMap | inputDataMap | Springframework의 ModelMap객체 | | String | key | 화면에서 정의한 출력 데이터 셋 이름 | | List | listData | 화면으로 송신할 출력 데이터 | === Return Value === 해당없음. === Description === 화면으로 데이터 송신시 xframe5 전용뷰를 사용할 수 있으며 이때 사용하는 출력데이터셋은 setOutPutData API 로 설정한 데이터셋명과 데이터가 된다. setOutputData API 에서 사용하는 출력데이터셋명은 화면에서 설정한 출력 데이터셋명이 된다. === Sample === List> empInfoList = xFrameService.selectSimpleList(); XFrameUtil.setOutputData(model, "ds_input", empInfoList); === See Also === ==== getCountFromMap ==== === Prototype === int getCountFromMap(Map model, String datasetName) === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | ModelMap | model |Springframework의 ModelMap객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | int | recordCount | 레코드 리스트 사이즈 | === Description === xFrame5Map API 로 생성한 Map 에서 datasetName 파라미터에 해당하는 입력데이터셋의 레코드 수를 반환한다. === Sample === int recordCount = 0; Map reqMap = XFrame5Util.xFrame5Map(request, response, model); recordCount = XFrame5Util.getCountFromMap(reqMap, "DS_RES"); === See Also === ==== isDeleteRecord ==== === Prototype === bool isDeleteRecord(Map model, String datasetName, int nRecordIndex) === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | ModelMap | model |Springframework의 ModelMap객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | | int | nRecordIndex | 데이터 셋 이름으로 구해진 List에서 반환 시킬 레코드 순서 | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | boolean | true/false | 삭제된 레코드 여부 | === Description === xFrame5Map API 로 생성한 Map 에서 datasetName 파라미터에 해당하는 입력데이터셋의 레코드가 삭제된 레코드인지를 판단한다. === Sample === int recordCount = 0; int nRow = 0; Map reqMap = XFrame5Util.xFrame5Map(request, response, model); recordCount = XFrame5Util.getCountFromMap(reqMap, "DS_RES"); for (nRow = 0; nRow < recordCount; nRow++) { if (XFrame5Util.isDeleteRecord(reqMap, "DS_RES", nRow)) { System.out.println("DELETE RECORD"); } } === See Also === isInsertRecord, isUpdateRecord ==== isInsertRecord ==== === Prototype === bool isInsertRecord(Map model, String datasetName, int nRecordIndex) === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | ModelMap | model |Springframework의 ModelMap객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | | int | nRecordIndex | 데이터 셋 이름으로 구해진 List에서 반환 시킬 레코드 순서 | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | boolean | true/false | 추가된 레코드 여부 | === Description === xFrame5Map API 로 생성한 Map 에서 datasetName 파라미터에 해당하는 입력데이터셋의 레코드가 추가된 레코드인지를 판단한다. === Sample === int recordCount = 0; int nRow = 0; Map reqMap = XFrame5Util.xFrame5Map(request, response, model); recordCount = XFrame5Util.getCountFromMap(reqMap, "DS_RES"); for (nRow = 0; nRow < recordCount; nRow++) { if (XFrame5Util.isInsertRecord(reqMap, "DS_RES", nRow)) { System.out.println("INSERT RECORD"); } } === See Also === isDeleteRecord, IsUpdateRecord ==== isUpdateRecord ==== === Prototype === boolean isUpdateRecord(Map model, String datasetName, int nRecordIndex) === Parameter === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | ModelMap | model |Springframework의 ModelMap객체 | | String | datasetName | 화면에서 정의한 입력 데이터 셋 이름 | | int | nRecordIndex | 데이터 셋 이름으로 구해진 List에서 반환 시킬 레코드 순서 | === Return Value === |< 100% 100px 200px - >| ^ Type ^ Name ^ 설명 ^ | boolean | true/false | 변경된 레코드 여부 | === Description === xFrame5Map API 로 생성한 Map 에서 datasetName 파라미터에 해당하는 입력데이터셋의 레코드가 변경된 레코드인지를 판단한다. === Sample === int recordCount = 0; int nRow = 0; Map reqMap = XFrame5Util.xFrame5Map(request, response, model); recordCount = XFrame5Util.getCountFromMap(reqMap, "DS_RES"); for (nRow = 0; nRow < recordCount; nRow++) { if (XFrame5Util.isUpdateRecord(reqMap, "DS_RES", nRow)) { System.out.println("UPDATE RECORD"); } } === See Also === isDeleteRecord, isInsertRecord