XFrame5Util API Reference

xframe5util 을 사용하기 위해서는 xframe5View 와 beanNameViewResolver 가 선언되어 있어야 한다.

() 안에 Method 는 @Deprecated 를 의미하며 code refactoring 이유로 제거 될 예정이다.

Map<String, Object> xFrame5Map(HttpServletRequest request, HttpServletResponse response, ModelMapmodel);

XFrame5 화면과 서버와의 통신시 request 의 파라미터에 데이터 셋, 글로벌 데이터 셋, 화면 메타 정보등이 담겨 송신된다(데이터셋에 담기는 데이터 항목에 대한 자세한 설명은 xDataSet5 DevGuide 문서 참고)

xFrame5Map API 에서는 request, response 를 사용하여 xDataSet5 객체를 생성하며 이를 Map 형식으로 사용하기 위해 Map<String, List<Map<String, Object»>형태로 변환하여 반환한다.

반환값인 맵에 포함되는 데이터는 아래와 같다.

1. 데이터셋 오브젝트: XFrame5View.XFRAME5_XDATASET5, xDataSet5 오브젝트
2. 파라미터 데이터: 파라미터네임, 파라미터값(xTranMap Url 의 지정한 파라미터 데이터)
3. 데이터셋 데이터: 데이터셋이름, 데이터셋 데이터
   데이터셋 데이터 구조: 데이터셋 레코드 데이터 리스트
   데이터셋 레코드 데이터 구조: 맵<데이터셋 칼럼 이름(문자열), 데이터셋 칼럼 값(문자열)>

Map<String, Object> reqMap = XFrame5Util.xFrame5Map(request, response, model);

void printMetaInfoMap(Map<String, Object> xf5Map);

해당없음.

xframe5Map API 를 사용해 생성된 Map 객체에는 화면 메타 정보가 포함되어 있으며 화면 메타 정보에는 화면 경로 및 이름, 사용자 시스템 IP 주소, 트랜잭션 맵 ID 등의 정보가 포함되어 있다.

printMetaInfoMap API 는 화면 메타 정보를 로그로 출력 하는 기능을 하며, apache 에서 제공하는 LogFactory 클래스를 사용하여 info 로그레벨로 출력한다.

Map<String, Object> reqMap = XFrame5Util.xFrame5Map(request, response, model);
XFrame5Util.printMetaInfoMap(reqMap);

List<Map<String, Object>> getDataMapList(Map<String, Object> inputDataMap, String datasetName);

XFrame5Map API 의 반환값인 Map 객체에는 화면에서 정의한 입력데이터셋의 값이 Map<String, List>형식으로 포함되어 있다.

getDataMapList API 를 사용하여 지정한 키값의 List 를 반환할 수 있다.

반환된 List 는 Map<String, Object>로 구성된다.

Map<String, Object> reqMap = XFrame5Util.xFrame5Map(request, response, model);
List<Map<String,Object>> recordList = XFrame5Util.getDataMapList(reqMap, "ds_input");

getDataMap

Map<String, Object> getDataMap(Map<String, Object> inputDataMap, String datasetName, intnRecordIndex);

xFrame5Map API 를 사용하여 반환된 Map 은 Map<String, List<Map<String, Object»>형식을 이루게 된다.

getDataMap API 는 입력 데이터셋에 해당하는 List 값에서 레코드 인덱스 파라미터에 해당하는 Map<String, Object>값을 반환한다

MMap<String, Object> reqMap = XFrame5Util.xFrame5Map(request, response, model);
List<Map<String, Object>> empInfoList = xFrame5Service.selectDataConvList(XFrame5Util.getDataMap( reqMap, "ds_input", 0));

getDataMapList

Object getDataBean(Map<String, Object> inputDataMap, String datasetName, int nRecordIndex, String beanClassName);

xFrame5Map API 를 사용하여 반환된 Map 은 Map<String, List<Map<String, Object»>형식을 이루게 된다.

getDataBean API 는 입력 데이터셋에 해당하는 List 값에서 레코드 인덱스 파라미터에 해당하는 레코드를 지정한 Object 형으로 반환한다.

Map<String, Object> reqMap = XFrame5Util.xFrame5Map(request, response, model);
ExampleVO exampleVO = (ExampleVO) XFrame5Util.getDataBean(reqMap, "DS_REQ", 0, ExampleVO.class.getName());
List<ExampleVO> empVOList = (List<ExampleVO>)exampleService.selectVOListByVO(exampleVO);

getDataBeanList

List getDataBeanList(Map<String, Object> inputDataMap, String datasetName, int nRecordIndex, String beanClassName);

xFrame5Map API 를 사용하여 반환된 Map 은 Map<String, List<Map<String, Object»>형식을 이루게 된다.

getRecordFromBean API 는 입력데이터셋에 해당하는 List 값에서 레코드 인덱스 파라미터에 해당하는 Map<String, Object>값을 beanClassName 이름에 해당하는 VO List 형으로 변환하여 반환한다.

Map<String, Object> reqMap = XFrame5Util. xFrame5Map(request, response, model);
String className = "egovframework.example.sample.service.vo.EmpInfoVO";
List<EmpInfoVO> empVo = XFrame5Util.getDataBeanList(reqMap, "ds_input", 0, className);

getDataBean

String getDataString(Map<String, Object> inputDataMap, String datasetName, int nRecordIndex, String columnName, String defaultValue);

getDataString API 는 입력데이터셋에 해당하는 List 값에서 하나의 데이터 값만을 반환할 때 사용하는 API 이다.

getDataMap API 가 Map<String, Object>형태로 반환하게 되는데, getDataString API 는 여기에 칼럼이름을 파라미터로 전달하여 하나의 값을 String 타입으로 반환하게 된다.

Map<String, Object> reqMap = XFrame5Util.xFrame5Map(request, response, model);
String temp_emp_age = XFrame5Util.getDataString(reqMap, "ds_input", 0, "emp_age", "0");

void setOutputData(Map<String, Object> model, String key, List<Map<String, Object>> listData);

해당없음.

화면으로 데이터 송신시 xframe5 전용뷰를 사용할 수 있으며 이때 사용하는 출력데이터셋은 setOutPutData API 로 설정한 데이터셋명과 데이터가 된다.

setOutputData API 에서 사용하는 출력데이터셋명은 화면에서 설정한 출력 데이터셋명이 된다.

List<Map<String, Object>> empInfoList = xFrameService.selectSimpleList();
 
XFrameUtil.setOutputData(model, "ds_input", empInfoList);

int getCountFromMap(Map<String, Object> model, String datasetName)

xFrame5Map API 로 생성한 Map 에서 datasetName 파라미터에 해당하는 입력데이터셋의 레코드 수를 반환한다.

int recordCount = 0;
Map<String, Object> reqMap = XFrame5Util.xFrame5Map(request, response, model);
recordCount = XFrame5Util.getCountFromMap(reqMap, "DS_RES");

bool isDeleteRecord(Map<String, Object> model, String datasetName, int nRecordIndex)

xFrame5Map API 로 생성한 Map 에서 datasetName 파라미터에 해당하는 입력데이터셋의 레코드가 삭제된 레코드인지를 판단한다.

int recordCount = 0;
int nRow = 0;
Map<String, Object> 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");
    }
}

isInsertRecord, isUpdateRecord

bool isInsertRecord(Map<String, Object> model, String datasetName, int nRecordIndex)

xFrame5Map API 로 생성한 Map 에서 datasetName 파라미터에 해당하는 입력데이터셋의 레코드가 추가된 레코드인지를 판단한다.

int recordCount = 0;
int nRow = 0;
Map<String, Object> 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");
    }
}

isDeleteRecord, IsUpdateRecord

boolean isUpdateRecord(Map<String, Object> model, String datasetName, int nRecordIndex)

xFrame5Map API 로 생성한 Map 에서 datasetName 파라미터에 해당하는 입력데이터셋의 레코드가 변경된 레코드인지를 판단한다.

int recordCount = 0;
int nRow = 0;
Map<String, Object> 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");
    }
}

isDeleteRecord, isInsertRecord