WebSquare.uiplugin.dataMap

Data통신 및 화면에서 사용 할 Data로 key와 value로 이루어진 단일 객체이다. JAVA의 MAP 객체와 비슷한 구조롤 띄고 있다.
DataCollectoin 하위에 생성되며 데이터의 구조를 정의하는 Key Info 영역과 초기값을 정의하는 Data 영역으로 나뉘어 있다.
Key Info 영역(source : <w2:keyInfo>)은 key의 정보가 있으며 key의 id 속성에 key의 이름을 정의한다.
Data 영역(source : <w2:data>)은 key의 초기값을 정의하는 곳이며 use data가 체크되어있어야(source : <w2:data use="true">) 초기값이 적용된다.

Type

uiplugin

Property Summary

attributeMap: DataType이 XML 일 경우만 적용이 되는 기능으로 rootNode에 추가 attribute(속성)을 지정하고자 하는 DataMap의 이름
baseNode: [default:map] DataType이 XML 일 경우만 적용되며 데이터를 XML로 변환 시 root 노드로 정의 할 XPath를 명시한다
defaultValue: key의 초기값
firstSet: dataMap에 초기값을 정의하지 않았을 경우 API(setValue 등) 또는 사용자가 최초 입력한 값을 초기값으로 설정 할지의 여부.
firstSetSubmission: dataMap에 setJSON, setXML API를 호출하거나 submission을 날려서 dataMap 데이터가 갱신된 경우 그 갱신된 값을 초기값을 설정할지에 대한 여부
id: DataMap의 ID로 전역객체로 할당되며 submission 또는 $w의 get API를 사용 할 경우 data를 구분하기 위한 key로 사용된다
idAttribute: DataType이 XML 일 경우만 적용이 되는 기능으로 dataMap의 id에 정의 된 값을 id attribute(속성)가 아닌 다른 attribute(본 속성에 정의 한 값)로 정의하고자 할 경우 사용된다
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성
valueAttribute: DataType이 XML 일 경우만 적용되며 실 데이터를 attribute(속성)에 할당 할 때 사용된다

Event Summary

onmodelchange: 특정 key에 대한 value가 변경 된 경우 발생합니다
onsetdata: setJSON 또는 setXML API와 같이 데이터를 set 해줄 때 또는 submission의 target과 연동되어 통신의 결과가 set 될 때 발생하는 이벤트이다.

Method Summary

bind( eventType , function ): dataMap의 이벤트를 동적으로 할당한다
get( key ): KeyInfo에 정의되어있는 Key ID에 할당 된 value를 반환한다
getArray( ): DataMap 전체 데이터를 KeyInfo에 정의 된 순서대로 array에 담아 반환한다
getCount( ): DataMap에 정의 된 key의 개수를 반환한다
getID( ): dataMap 객체의 id를 반환한다
getIndex( keyID ): key의 ID로 KeyInfo에 정의 된 key의 index를 반환한다
getInfo( ): dataMap의 세부 정보를 조회한다
getJSON( ): DataMap 전체 데이터를 JSON으로 반환한다
getKey( keyIndex ): key의 index를 받아 ID명을 반환한다
getKeyInfo( key ): dataMap 특정 key의 세부 정보를 조회한다
getModifiedArray( ): DataMap의 original 데이터와 현재 데이터의 값이 다른 key array와 value array를 JSON으로 반환한다
getModifiedData( ): DataMap의 original 데이터와 현재 데이터의 값이 다른 key들의 value를 배열로 반환한다
getModifiedIndex( ): DataMap의 original 데이터와 현재 데이터의 값이 다른 key들의 Index를 배열로 반환한다
getModifiedJSON( ): DataMap의 original 데이터와 현재 데이터의 값이 다른 key들을 JSON으로 반환합니다
getModifiedKey( ): DataMap의 original 데이터와 현재 데이터의 값이 다른 Key들을 배열로 반환한다
getModifiedXML( ): DataMap의 original 데이터와 현재 데이터의 값이 다른 key들을 XML로 반환합니다
getName( keyID ): KeyInfo에 정의 된 key의 id로 name에 정의 된 값을 반환한다
getObjectType( ): dataCollection의 Type을 반환한다
getOption( attr ): 속성명으로 dataMap에 정의 된 속성의 값을 반환한다
getOriginal( KeyID ): KeyInfo에 정의 된 Key ID에 할당 된 초기값을 반환한다
getType( KeyID ): KeyInfo에 정의 된 Key의 dataType 속성 값을 반환한다
getXML( ): DataMap의 전체 데이터를 XML 형태로 반환한다
redo( ): 데이터를 변경된 시점 최근 한단계로 되돌린다
reform( ): DataMap의 key의 상태를 초기화하고 original값을 현재의 key값으로 변경한다
restore( ): 데이터를 이전 한단계로 되돌린다
set( KeyID , KeyValue ): DataMap에 정의 된 Key ID에 value를 셋팅한다
setArray( arrayData ): DataMap의 전체 데이터를 Array로 셋팅한다
setEmptyValue( ): key값을 확인하여 빈 값을 셋팅합니다. 디폴트 값이 있는 경우, 디폴트 값으로 셋팅됩니다.
setJSON( jsonData ): DataMap의 전체 데이터를 JSON으로 셋팅한다
setXML( xmlData ): DataMap의 전체 데이터를 XML로 셋팅한다
trigger( eventType , paramArray ): dataMap에 등록 된 특정 이벤트를 직접 발생시킨다
unbind( eventType , function ): dataMap의 정의 된 이벤트를 제거한다
undo( ): DataMap의 key value를 초기(original)값으로 변경한다

Property Detail

attributeMap: DataType이 XML 일 경우만 적용이 되는 기능으로 rootNode에 추가 attribute(속성)을 지정하고자 하는 DataMap의 이름. 본 속성에 명시 된 DataMap의 key와 value가 rootNode의 attribute(속성)이름과 value로 정의 된다.
baseNode: [default:map] DataType이 XML 일 경우만 적용되며 데이터를 XML로 변환 시 root 노드로 정의 할 XPath를 명시한다.
defaultValue: key의 초기값
firstSet: dataMap에 초기값을 정의하지 않았을 경우 API(setValue 등) 또는 사용자가 최초 입력한 값을 초기값으로 설정 할지의 여부.
true로 설정시 빈 값('')으로, false로 설정 한 경우 API(setValue 등) 또는 사용자가 최초 입력한 값이 초기값으로 설정한다.
firstSetSubmission: dataMap에 setJSON, setXML API를 호출하거나 submission을 날려서 dataMap 데이터가 갱신된 경우 그 갱신된 값을 초기값을 설정할지에 대한 여부
true설정 시 submission을 날릴 때마다 해당 data를 초기값으로 설정한다.
id: DataMap의 ID로 전역객체로 할당되며 submission 또는 $w의 get API를 사용 할 경우 data를 구분하기 위한 key로 사용된다.
idAttribute: DataType이 XML 일 경우만 적용이 되는 기능으로 dataMap의 id에 정의 된 값을 id attribute(속성)가 아닌 다른 attribute(본 속성에 정의 한 값)로 정의하고자 할 경우 사용된다.
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.
valueAttribute: DataType이 XML 일 경우만 적용되며 실 데이터를 attribute(속성)에 할당 할 때 사용된다. (defulat:TextNode)

Event Detail

onmodelchange

특정 key에 대한 value가 변경 된 경우 발생합니다.

Parameter
name	type	description
info	Object	key, oldValue, newValue를 포함한 오브젝트를 반환합니다.

Sample

onsetdata

setJSON 또는 setXML API와 같이 데이터를 set 해줄 때 또는 submission의 target과 연동되어 통신의 결과가 set 될 때 발생하는 이벤트이다.
컴포넌트와 바인딩 되어있는 경우 컴포넌트에 값이 셋팅 되기 전에 발생된다.

Method Detail

bind( eventType , function )

dataMap의 이벤트를 동적으로 할당한다.

Parameter
name	type	required	description
eventType	String	Y	동적으로 할당할 이벤트의 이름
function	Function	Y	동적으로 할당 할 이벤트의 핸들러 함수.

Sample

//dataMap의 id가 dataMap1 인 경우 dataMap1.bind("onsetdata", function(e){ alert("date setting");}); //event 함수를 commObj.fn_dcDataSet 으로 정의 한 경우 dataMap1.bind("onsetdata", commObj.fn_dcDataSet );

get( key )

KeyInfo에 정의되어있는 Key ID에 할당 된 value를 반환한다. value의 초기값은 ""(empty string)이다.

Parameter
name	type	required	description
key	String	Y	Key ID.

Return
type	description
Object	Key ID에 할당 된 value. ( return type은 일반적으로 String이 대부분이며 초기 셋팅 한 data의 type 형태로 반환된다.)

getArray( )

DataMap 전체 데이터를 KeyInfo에 정의 된 순서대로 array에 담아 반환한다.

Return
type	description
Array	DataMap 전체 데이터가 담긴 1차원 Array.

Sample

//dataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> <addr></addr> </w2:data> </w2:dataMap> var tmpArr = dataMap1.getArray(); //return 예시 ) ["웹스퀘어", ""]

getCount( )

DataMap에 정의 된 key의 개수를 반환한다.

Return
type	description
Number	DataMap에 정의 된 key의 개수

getID( )

dataMap 객체의 id를 반환한다. 객체의 id 속성과 동일한 값을 반환한다.

Return
type	description
String	dataMap 객체의 ID.

getIndex( keyID )

key의 ID로 KeyInfo에 정의 된 key의 index를 반환한다.

Parameter
name	type	required	description
keyID	String	Y	KeyInfo에 정의 된 id.

Return
type	description
Number	keyID의 index.

getInfo( )

dataMap의 세부 정보를 조회한다.

Return
type	description
JSON	{dataMapInfo : dataMap의 attribute값, keyInfo : 각 key의 attribute들을 모아둔 object} 형태의 json객체

Sample

// dataMap1.getInfo();

getJSON( )

DataMap 전체 데이터를 JSON으로 반환한다.

Sample

//dataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> <addr></addr> </w2:data> </w2:dataMap> var tmpJSON = dataMap1.getJSON(); //return 예시 - String으로 변환 ) {name: "웹스퀘어", addr: "" }

getKey( keyIndex )

key의 index를 받아 ID명을 반환한다.

Parameter
name	type	required	description
keyIndex	Number	Y	KeyInfo에 정의 된 key의 index.

Return
type	description
String	key의 ID.

Sample

//dataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> <addr></addr> </w2:data> </w2:dataMap> var tmpKeyNm = dataMap1.getKey(0); //return 예시 ) "name"

getKeyInfo( key )

dataMap 특정 key의 세부 정보를 조회한다.

Parameter
name	type	required	description
key	String	Y	조회하고자 하는 key

Return
type	description
JSON	해당 key의 attribute를 표현한 json 객체

Sample

// dataList1.getKeyInfo("key1");

getModifiedArray( )

DataMap의 original 데이터와 현재 데이터의 값이 다른 key array와 value array를 JSON으로 반환한다. DataMap의 firstSet속성과 연관되어있다.

Return
type	description
JSON	original 데이터와 현재 값이 다른 key array와 value array가 담긴 JSON.

Sample

//name과 addr이 정의 되어있는 dataMap에서 name의 value를 "인스웨이브"로 수정 한 경우 var modJsonArray = dataMap1.getModifiedArray(); //return 예시 - String으로 변환 시 ) { key : ["name"] , value : ["인스웨이브"] }

getModifiedData( )

DataMap의 original 데이터와 현재 데이터의 값이 다른 key들의 value를 배열로 반환한다. DataMap의 firstSet속성과 연관되어있다.

Return
type	description
Array	original 데이터와 현재값이 다른 key들의 value가 담긴 Array.

Sample

//name과 addr이 정의 되어있는 dataMap에서 name의 value를 "인스웨이브"로 수정 한 경우 var modArray = dataMap1.getModifiedData(); //return 예시 ) [ "인스웨이브" ]

getModifiedIndex( )

DataMap의 original 데이터와 현재 데이터의 값이 다른 key들의 Index를 배열로 반환한다. DataMap의 firstSet속성과 연관되어있다.

Return
type	description
Array	original 데이터와 현재값이 다른 key들의 Index가 담긴 Array.

Sample

//name과 addr이 정의 되어있는 dataMap에서 name의 value를 "인스웨이브"로 수정 한 경우 var modArray = dataMap1.getModifiedIndex(); //return 예시 ) [0]

getModifiedJSON( )

DataMap의 original 데이터와 현재 데이터의 값이 다른 key들을 JSON으로 반환합니다. DataMap의 firstSet속성과 연관되어있다.

Return
type	description
JSON	DataMap의 original 데이터와 현재 데이터의 값이 다른 key와 value가 담긴 JSON.

Sample

//name과 addr이 정의 되어있는 dataMap에서 name의 value를 "인스웨이브"로 수정 한 경우 var modJSON = dataMap1.getModifiedJSON(); //return 예시 - String으로 변환 시 ) { name: "인스웨이브" }

getModifiedKey( )

DataMap의 original 데이터와 현재 데이터의 값이 다른 Key들을 배열로 반환한다. DataMap의 firstSet속성과 연관되어있다.

Return
type	description
Array	original 데이터와 현재값이 다른 key가 담긴 Array.

Sample

//name과 addr이 정의 되어있는 dataMap에서 name의 value를 "인스웨이브"로 수정 한 경우 var modKeyArr = dataMap1.getModifiedKey(); //return 예시 ) ["name"]

getModifiedXML( )

DataMap의 original 데이터와 현재 데이터의 값이 다른 key들을 XML로 반환합니다. DataMap의 firstSet속성과 연관되어있다.

Return
type	description
XML	DataMap의 original 데이터와 현재 데이터의 값이 다른 key와 value가 담긴 XML.

Sample

//name과 addr이 정의 되어있는 dataMap에서 name의 value를 "인스웨이브"로 수정 한 경우 var modXML = dataMap1.getModifiedXML(); //return 예시 - String으로 변환 시 ) <map id="dataMap1"><name>인스웨이브</name></map>

getName( keyID )

KeyInfo에 정의 된 key의 id로 name에 정의 된 값을 반환한다.

Parameter
name	type	required	description
keyID	String	Y	KeyInfo에 정의 된 Key ID.

Return
type	description
String	KeyInfo에 정의 된 Key Name.

Sample

getObjectType( )

dataCollection의 Type을 반환한다.

Return
type	description
String	[dataMap, dataList, linkedDataList] dataCollection의 타입을 반환한다.

Sample

var dataCollectionType = dataMap1.getObjectType(); // dataCollectionType dataMap1의 type인 dataMap를 반환합니다. return 예시 ) "dataMap"

getOption( attr )

속성명으로 dataMap에 정의 된 속성의 값을 반환한다.

Parameter
name	type	required	description
attr	String	Y	속성명.

Return
type	description
String	dataMap에 정의 된 속성의 값.

Sample

//dataMap 예시 <w2:dataMap id="dataMap1" baseNode="map"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> var tmpAttr = dataMap1.getOption("baseNode"); //return 예시 ) "map"

getOriginal( KeyID )

KeyInfo에 정의 된 Key ID에 할당 된 초기값을 반환한다.

Parameter
name	type	required	description
KeyID	String	Y	Key ID.

Return
type	description
Object	Key ID에 할당 한 초기값. ( return type은 일반적으로 String이 대부분이며 초기 셋팅 한 data의 type 형태로 반환된다.)

Sample

//dataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> </w2:data> </w2:dataMap> //name의 value set. dataMap1.set("name","inswave"); //name의 value get //var tmpData = dataMap1.get("name"); //return 예시 ) "inswave" //name의 초기값 get. var tmpOrgData = dataMap1.getOriginal("name"); //return 예시 ) "웹스퀘어"

getType( KeyID )

KeyInfo에 정의 된 Key의 dataType 속성 값을 반환한다.

Parameter
name	type	required	description
KeyID	String	Y	Key ID.

Return
type	description
String	Key의 dataType 속성 값.

Sample

//dataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> var keyType = dataMap1.getType(); //return 예시 ) "text"

getXML( )

DataMap의 전체 데이터를 XML 형태로 반환한다.

Return
type	description
XML	XML 타입의 전체 데이터

Sample

//dataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> <addr></addr> </w2:data> </w2:dataMap> var tmpXML = dataMap1.getXML(); //return 예시 ) //<map id="dataMap1"> // <name>웹스퀘어</name> // <addr></addr> //</map>

redo( )

데이터를 변경된 시점 최근 한단계로 되돌린다.

reform( )

DataMap의 key의 상태를 초기화하고 original값을 현재의 key값으로 변경한다.

restore( )

데이터를 이전 한단계로 되돌린다.

set( KeyID , KeyValue )

DataMap에 정의 된 Key ID에 value를 셋팅한다.

Parameter
name	type	required	description
KeyID	String	Y	Key의 ID.
KeyValue	String	Y	Key에 할당 할 value.

Sample

setArray( arrayData )

DataMap의 전체 데이터를 Array로 셋팅한다. array의 value index(순서)는 DataMap에 정의 된 Key의 index(순서)와 동일해야한다.

Parameter
name	type	required	description
arrayData	Array	Y	KeyInfo에 정의 된 key 순서/개수와 동일하고 value만 담긴 Array.

Sample

//dataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> dataMap1.setArray( ["웹스퀘어","서울시"] ); //정상 동작 dataMap1.setArray( ["웹스퀘어"] ); //오류 발생

setEmptyValue( )

key값을 확인하여 빈 값을 셋팅합니다. 디폴트 값이 있는 경우, 디폴트 값으로 셋팅됩니다.
(OriginalData와 현재데이터 모두 빈 값으로 셋팅합니다.)
(버전 정보: 5.0_1.2801B.20170922.172627 버전에서 추가.)

setJSON( jsonData )

DataMap의 전체 데이터를 JSON으로 셋팅한다. 전체 Key가 있을 필요는 없으며 DataMap에 정의 된 Key만 셋팅된다.

Parameter
name	type	required	description
jsonData	JSON	Y	JSON형태의 DataMap의 전체 데이터.

Sample

setXML( xmlData )

DataMap의 전체 데이터를 XML로 셋팅한다. 전체 Key가 있을 필요는 없으며 DataMap에 정의 된 Key만 셋팅된다.

Parameter
name	type	required	description
xmlData	XML	Y	XML형태의 DataMap의 전체 데이터.

Sample

//dataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> var tmpStr = "<map><name>웹스퀘어</name></map>"; //XML String. var tmpXML = WebSquare.xml.parse(tmpStr); //XML 변환 dataMap1.setXML( tmpXML );

trigger( eventType , paramArray )

dataMap에 등록 된 특정 이벤트를 직접 발생시킨다.

Parameter
name	type	required	description
eventType	String	Y	발생시킬 이벤트 이름
paramArray	Array	N	이벤트 핸들러에 전달 할 파라미터 배열

Sample

// dataMap1에 onmodelcahnge이벤트를 발생시키고 핸들러 함수에 {key: "name", oldValue: "WebSquare", newValue: "Inswave"} 인자를 전달하여 호출한다. dataMap1.trigger( "onmodelchange" , [ {key: "name", oldValue: "WebSquare", newValue: "Inswave"} ] );

unbind( eventType , function )

dataMap의 정의 된 이벤트를 제거한다.

Parameter
name	type	required	description
eventType	String	N	제거할 이벤트의 이름. 생략할 경우 모든 이벤트를 제거한다.
function	Function	N	동적으로 event에 function을 할당 한 경우 제거 할 이벤트 핸들러 함수. 생략 할 경우 해당 이벤트 type으로 등록된 모든 핸들러 함수를 제거한다.

Sample

// dataMap1에 등록된 onmodelchange 이벤트 제거. dataMap1.unbind("onmodelchange"); //dataMap1.bind("onmodelchange", fn_dataMapChage) 와 같이 동적으로 이벤트와 이벤트 핸들러를 등록 한경우 아래와 같이 제거가 가능하다. ( 이벤트에 bind 된 이벤트 핸들러 제거 ) dataMap1.unbind("onmodelchange", fn_dataMapChage); // dataMap1에 등록된 onmodelchange이벤트의 이벤트 핸들러 함수 중에 fn_dataMapChage를 제거

undo( )

DataMap의 key value를 초기(original)값으로 변경한다.