이 페이지의 내용
문서기능 가이드
기능 가이드02

공통 컬럼 속성

아이템으로 여러 컬럼의 공통 설정을 관리합니다.

한국어 문서약 14분

공통 컬럼 속성이란?

모델(BindModel)에서 컬럼을 직접 관리할 수 있지만, 다음과 같은 경우에는 공통 속성을 사용하는 것이 유리합니다:

  • 여러 테이블에서 동일한 컬럼 속성을 공유해야 할 때
  • 서비스 객체를 구성하며 컬럼 속성을 정의해야 할 때
  • 컬럼의 selector 속성의 유효성을 검사해야 할 때

모델(BindModel)의 기본 테이블(first) 외에 추가 테이블을 사용하는 경우, 중복되는 컬럼 속성을 효율적으로 관리하기 위해 공통 속성을 활용합니다. 또는 서비스 객체 주입을 통해 컬럼 속성을 통합적으로 관리할 수도 있습니다.

아이템 구성#

items 속성은 컬럼의 공통 속성 객체 관리하는 컬렉션입니다.

아이템을 구성할 때, 각 항목은 컬럼 속성으로 사용되는 타입입니다.

ts
type KeyType = 'value' | 'text' | 'html' | 'attr.*' | 'prop.*' | 'css.*' | 'none';
type ValType = string | number | boolean;
type RegExpType = { reg: RegExp, msg: string, match?: boolean };
type FuncType = (value: any) => boolean;
type ConstraintType = RegExpType | FuncType;

type ColumnType = {
	columnName?: string,
    selector?: { key: string, type: KeyType },
    getter?: () => any,
    setter?: (val: any) => any,
    getFilter?: () => any,
    setFilter?: (val: any) => any,
    default?: string | number | boolean | null, // 기본값
    value?: ValType,
    alias?: string,
    caption?: string,
    constraints?: ConstraintType | ConstraintType[],  // 제약조건
    required?: boolean,             // 필수여부
};

컬렉션에서 아이템 구성하기#

ts

declare function add(
	key: string, 
	prop: Record<string, ColumnType> | ValType
): number;
  • add() : items 컬렉션에 키의 속성값을 추가합니다.
    • key : 아이템 이름(중복 불가)
    • prop : 컬럼 기본값 또는 컬럼의 주요 속성 키와 값

MetaView(valid)에서 value에 대한 유효성 검사를 위해 required 및 constraints 속성을 사용합니다. 값(value)을 설정하거나 가져올때는 selector, getter, setter, getFilter, setFilter를 활용할 수 있습니다.

js
const bm = new BindModel();

// 아이템 추가
bm.items.add('aa', 10);
bm.items.add('bb', 'B');
bm.items.add('cc', { columnName: 'CCC' });
bm.items.add('dd', { selector: { key:'#ID', type: 'value' } });

// bm.items.count === 4
// bm.items['aa'] === 10
// bm.items['bb'] === 'B'
// bm.items['cc'] === { columnName: 'CCC' }
// bm.items['dd'] === { selector: { key:'#ID', type: 'value' } }

서비스객체로 아이템 구성하기#

items 속성은 서비스 객체를 통해 정의하여 보다 구조적으로 관리할 수 있습니다.

ts
type ItemType = Record<string, ColumnType> | ValType;  // `string` 은 컬럼 속성명
type ServiceType = {
	items?: Record<string, ItemType> // `string` 은 아이템명
	/* etc ... */
};

declare function setService(service: ServiceType, chkService: boolean): void;
  • setService() : 서비스객체에 items 속성을 통해 아이템을 등록할 수 있습니다.
js
const bm = new BindModel();

bm.setService({
	items: {
		aa: 10,
		bb: 'B',
		cc: { columnName: 'CCC' },
		dd: { selector: { key:'#ID', type: 'value' } },
	}
});

// bm.items.count === 4
// bm.items['aa'] === 10
// bm.items['bb'] === 'B'
// bm.items['cc'] === { columnName: 'CCC'}
// bm.items['dd'] === { selector: { key:'#ID', type: 'value'}}

Tip 서비스 객체에는 items 속성 외에도 command, mapping, fn 속성 을 포함할 수 있습니다.

참조 : 서비스객체 주입

아이템 매핑#

아이템의 속성을 여러 테이블에 매핑하여 등록할 수 있습니다.

매핑 객체에 대한 타입 정의

ts
type ColumnKey = string;  // 예: 'aa', 'first.bb', 'second.cc'
type CommandKey = string| '$all'; // 예: 'read', 'write', '$all'
type ViewEntry = 'valid' | 'bind' | 'output' | 'misc' | '$all';
type CommandMapping = Record<CommandKey, ViewEntry | ViewEntry[]> | {};
type MappingObject = Record<ColumnKey, CommandMapping>;

type ServiceType = {
	mapping?: MappingObject
	/* etc ... */
};
  • CommandMapping에 {} 를 지정하면, 해당 컬럼은 명령과는 매핑되지 않고, 단순히 아이템 객체를 컬럼으로만 등록됩니다.
  • CommandKey로 지정하면, 해당 키에 해당하는 명령이 존재하지 않을 경우 새로운 명령(BindCommand) 객체가 해당 키로 추가됩니다.

Tip MappingObject는 서비스 객체의 mapping 속성 또는 setMapping(mapping) 메서드의 인자 타입으로 사용됩니다.

서비스객체로 매핑#

모델(BindModel) 객체를 생성할 때, 서비스 객체를 활용하여 여러 컬럼을 일괄 등록할 수 있습니다.

js
const bm = new BindModel({
	tables: ['second'],  // 추가할 테이블 이름
	items: {
		aa: 10,
		bb: 20,
		cc: 30
	},
	mapping: {
		'aa': {},         // 기본 테이블(first)에 'aa' 매핑
		'first.bb': {},   // 기본 테이블(first)에 'bb' 매핑
		'second.bb': {},  // 'second' 테이블에 'bb' 매핑
		'second.cc': {},  // 'second' 테이블에 'cc' 매핑
	}
});

// bm.items.count          == 3 ('aa', 'bb', 'cc')
// bm.first.columns.count  == 2 ('aa', 'bb')
// bm.second.columns.count == 2 ('bb', 'cc')

// bm.first.columns['aa'].value  == 10
// bm.first.columns['bb'].value  == 20
// bm.second.columns['bb'].value == 20
// bm.second.columns['cc'].value == 30
  • tables : 추가할 테이블 이름을 지정합니다.
    • 매핑에 지정한 테이블이 존재하지 않으면, 해당 테이블이 자동으로 생성됩니다.
  • mapping : 아이템과 테이블 컬럼 간 매핑을 설정합니다.

Tip

매핑 이름 규칙 : [테이블명 . ]컬럼명 | 아이템명 테이블명이 생략 되면 기본테이블에 등록됩니다. 적용 대상 : mapping(), setColumn(), items 정의

등록된 아이템 매핑하기#

이미 등록된 아이템에 공통 속성을 지정하여 매핑하거나, 빈 속성을 사용해 컬럼과 명령별 역할(뷰)을 일괄 등록 할 수 있습니다.

기존에 items 컬렉션에만 공통 속성이 정의되어 있는 경우, 컬럼을 새로 등록한 후 명령별 역할(뷰)에 매핑합니다.

반면, 테이블에 이미 등록된 컬럼의 경우에는 해당 컬럼을 명령별 역할(뷰)에 그대로 매핑하여 처리합니다.

ts
declare function setMapping(
	mapping: MappingObject,  // 아이템 매핑 타입 참조
	bTable?: MetaTable | string
): void;
  • mapping : 매핑 객체 또는 매핑 컬렉션 객체.
  • bTable : 기본 테이블로 지정할 테이블 이름 또는 MetaTable 객체.

예제 : 아이템을 테이블에 컬럼으로 등록하기#

명령 매핑을 빈객체 {} 로 표현할 경우 대상테이블에 컬럼이 등록됩니다.

js
const bm = new BindModel();

// 테이블 추가
bm.addTable('second');

// 아이템 추가
bm.items.add('aa', 10);
bm.items.add('bb', 20);
bm.items.add('cc', 30);

// 매핑 설정
bm.setMapping({
	'aa': {},         // 기본 테이블(first)에 'aa' 매핑
	'first.bb': {},   // 기본 테이블(first)에 'bb' 매핑
	'second.bb': {},  // 'second' 테이블에 'bb' 매핑
	'second.cc': {},  // 'second' 테이블에 'cc' 매핑
});

// bm.items.count          == 3 ('aa', 'bb', 'cc')
// bm.first.columns.count  == 2 ('aa', 'bb')
// bm.second.columns.count == 2 ('bb', 'cc')

// bm.first.columns['aa'].value  == 10
// bm.first.columns['bb'].value  == 20
// bm.second.columns['bb'].value == 20
// bm.second.columns['cc'].value == 30
  • addTable() : 지정한 이름의 테이블을 추가합니다.
  • setMapping() : 매핑 객체를 사용해 아이템과 테이블 간 매핑을 처리합니다.

예제 : 컬럼 등록 및 명령에 매핑하기#

아이템을 지정한 명령의 역활(뷰)에 매핑힙니다.

js
const bm = new BindModel();

bm.items.add('aa', 10);
bm.items.add('bb', 20);
bm.items.add('cc', 30);

// 매핑 설정
bm.setMapping({
	'aa': { cmd1: '$all' },         // 기본 테이블(first)에 'aa' 매핑
	'first.bb': { cmd1: 'output' },  // 전체 뷰 매핑
	'second.cc':  { cmd2: ['valid', 'bind']  }
});

// bm.items.count          == 3 ('aa', 'bb', 'cc')
// bm.first.columns.count  == 2 ('aa', 'bb')
// bm.second.columns.count == 1 ('cc')

// bm.first.columns['aa'].value  == 10
// bm.first.columns['bb'].value  == 20
// bm.second.columns['cc'].value == 30

// bm.command['cmd1'].valid.columns.count === 1  ('aa')
// bm.command['cmd1'].bind.columns.count === 1   ('aa')
// bm.command['cmd1'].output.columns.count === 1 ('aa', 'bb')

// bm.command['cmd2'].valid.columns.count === 1  ('cc')
// bm.command['cmd2'].bind.columns.count === 1   ('cc')
// bm.command['cmd2'].output.columns.count === 0

아이템 유효성 검사#

checkSelector()는 지정한 컬렉션 내 selector 속성의 유효성을 검사합니다.

ts
declare function checkSelector(
	collection?: PropertyCollection = this.items, 
	isLog: boolean = false
): string[];
  • checkSelector() : 대상 컬렉션의 selector 속성을 검사합니다.
    • collection : 검사 대상 컬렉션 (기본값: this.items)
    • isLog : true로 설정 시, 유효성 검사 실패 항목을 콘솔에 출력합니다.

Tip collection은 다음의 대상을 설정할 수 있습니다:

  • ['테이블명'].columns, items, columns, valid.columns, bind.columns, output.columns
js
const bm = new BindModel();

// 아이템 추가
bm.items.add('aa', { selector: { key:'#user_name',      type: 'value' }});
bm.items.add('bb', { selector: { key:'.sub_name',       type: 'text' }});
bm.items.add('cc', { selector: { key:'input[name=man]', type: 'none' }});

// 유효성 검사
bm.checkSelector(); // 빈 배열 반환: 검사 성공

// bm.items.count === 3

Tip 서비스객체 주입 시 DOM 유효성 검사는 preCheck 콜백 함수에서 처리할 수 있습니다.

유효성 검사는 지정된 컬렉션 내의 selector 속성에 대해 수행됩니다.

js
const bm = new BindModel();

// 컬럼 추가
bm.addColumnValue('aa', { selector: { key:'#user_name',      type: 'value' }});
bm.addColumnValue('bb', { selector: { key:'.sub_name',       type: 'text' }});
bm.addColumnValue('cc', { selector: { key:'input[name=man]', type: 'none' }});

// 유효성 검사
bm.checkSelector(bm.columns); // 빈 배열 반환: 검사 성공

// bm.columns.count === 3

selector 조회하기#

getSelector()를 사용해 컬렉션 내 selector 속성의 목록을 가져올 수 있습니다.

ts
type KeyType = 'none' | 'value' | 'text' | 'html' | 'prop' | 'attr' | 'css';
type SelectorType = { key: string, type: KeyType };

declare function getSelector(
    collection?: PropertyCollection = this.items
): SelectorType[];
  • collection : 조회할 컬렉션 (기본값: this.items)
js
const bm = new BindModel();

// 컬럼 추가
bm.columns.add('item1', { selector: { key:'#ID1', type: 'value' }});
bm.columns.add('item2', { selector: { key:'#ID2', type: 'text' }});

// `selector` 목록 조회
bm.getSelector();

// 반환 값 : [ { key:'#ID1', type: 'value' }, { key:'#ID2', type: 'text' } ]

Tip 컬렉션을 인자로 전달하면, 해당 컬렉션에 포함된 selector 목록을 가져올 수 있습니다.

검색어를 입력해 보세요.