[API/UI]

XmlFormat

개요

XmlFormat 클래스는 MetaData를 설정하기 위한 XML format을 설정/제어합니다.
XmlFormat 클래스의 주요 기능은 아래와 같습니다.
1. XML Format을 설정/제어합니다.
2. 서버 또는 Client에서 XML 형태로 받은 데이터를 XML Format에 매핑합니다.
3. XML format은 header와 detail로 구분됩니다.
    - header에는 단일 항목의 format를 작성하고
    - detail에는 반복되는 항목의 format을 작성합니다.
4. 서버는 'header'와 'detail'이 아닌 다른 이름을 지정할 수 있습니다.
    - 이를 매핑하는 방법은 groupName 프로퍼티를 참조하세요
5. header와 detail을 작성하지 않고 파라미터 순서에 맞추어도 됩니다.
    - example
    new mc.data.JsonFormat({
       header: [
           {field: 'year', mapName: 'salesYear', type: 'int'},
           {field: 'customer'}
       ]},
       detail: [
           {field: 'id', mapName: 'code'},
           {field: 'sales-item', mapName: 'goods'},
           {field: 'qty',  type: 'int'}
       ]},
       {header: 'serverHeader', detail: 'serverDetail'},
       ['created', function(){mc.resultShow('created Event')}, this]
    );
6. 서버 또는 client 데이터는 XmlFormat과 일치하도록 해야 합니다.
    - 특히 mapName을 작성한 경우 이 이름을 사용해야 합니다.

    <?xml version="1.0" encoding="utf-8" ?>
    <salesData>
        <header>
            <salesYear>2009</salesYear>
            <customer>MethodChain</customer>
        </header>
        <sales>
            <id>sales1</id>
            <goods>Book</goods>
            <qty>123</qty>
        </sales>
        <sales>
            <id>sales2</id>
            <goods>Computer</goods>
            <qty>456</qty>
        </sales>
    </salesData>
Options Component
ccode {String} data.XmlFormat
component code : 'xmlformat'
combo {String} data.DataFormat
ccode가 combo의 컴포넌트 id
DataFormat에 연결된 MetaData가 combo data인 경우 이를 설정할 combo 컴포넌트 id를 지정합니다.
field {String} data.DataFormat
field name
group {String} data.DataFormat
format 그룹. h: header, d: detail
mapName {String} data.DataFormat
mapping name
클라이언트와 서버의 field name이 다른 경우 매핑할 이름을 지정합니다.
type {String} data.DataFormat
field data type. default: string
지정할 수 있는 타입: string, int, float, date, boolean
Method Component
add (String hd, Hash/JSON hash) : JSON data.DataFormat
header 또는 detail에 field format을 추가합니다.
copy (String hd, String from, String to) : JSON data.DataFormat
header 또는 detail에서 field format을 복사합니다.
get (String hd, String field) : Hash data.DataFormat
header 또는 detail에서 지정한 field의 format을 추출합니다.
getAll (String hd) : JSON data.DataFormat
header 또는 detail의 모든 field의 format을 추출합니다.
remove (String hd, String fields) : JSON data.DataFormat
header 또는 detail에서 field format을 삭제합니다.
update (String hd, String fields) : JSON data.DataFormat
header 또는 detail에서 지정한 field의 값을 변경합니다.
 
Custom Event Component
add (Object this) data.DataFormat
header 또는 detail에 field format을 추가했을 때 fire 됩니다.
copy (Object this) data.DataFormat
header 또는 detail에서 field format을 복사했을 때 fire 됩니다.
created (Object this) data.XmlFormat
format 설정을 완료했을 때 fire됩니다.
remove (Object this) data.DataFormat
header 또는 detail에서 field format을 삭제했을 때 fire 됩니다.
update (Object this) data.DataFormat
header 또는 detail에서 지정한 field의 값을 변경했을 때 fire 됩니다.
Examples  
XmlFormat  
XmlFormat