Introduction

Record metadata describes a data item that can represent a collection of fields.

A record metadata object is immutable.

Default multiplicity is defined by the defaltMultiplicity class method on PTDiffusionMultiplicity.

Inheritance diagram for PTDiffusionRecordMetadata:

Properties
NSArray< __kindof PTDiffusionFieldMetadata * > *	fieldMetadata

Properties inherited from PTDiffusionMetadata
NSString *	name

PTDiffusionMultiplicity *	multiplicity

Instance Methods
(instancetype)	- initWithName:fieldMetadata:

(instancetype)	- initWithName:multiplicity:fieldMetadata:

(BOOL)	- isEqualToRecordMetadata:

Instance Methods inherited from PTDiffusionMetadata
(BOOL)	- isEqualToMetadata:

Method Documentation

- (instancetype) initWithName:	(NSString *)	name
fieldMetadata:	(NSArray< __kindof PTDiffusionFieldMetadata * > *)	fieldMetadata

Returns a record metadata object initialized with the given name, default multiplicity and given field metadata array.

Parameters

name	The name to use. It is used when looking up records that have been transformed using the receiver.
fieldMetadata	The field metadata defining what fields are expected as well as what order they should appear in. This array may not be empty.

Exceptions

NSInvalidArgumentException If any of the given arguments are nil or the field metadata array is empty.

- (instancetype) initWithName:	(NSString *)	name
multiplicity:	(PTDiffusionMultiplicity *)	multiplicity
fieldMetadata:	(NSArray< __kindof PTDiffusionFieldMetadata * > *)	fieldMetadata

Returns a record metadata object initialized with the given name, given multiplicity and given field metadata array.

Parameters

name	The name to use. It is used when looking up records that have been transformed using the receiver.
multiplicity	The multiplicity to use. It governs how many records can be transformed using the receiver from the enclosing record content.
fieldMetadata	The field metadata defining what fields are expected as well as what order they should appear in. This array may not be empty.

Exceptions

NSInvalidArgumentException If any of the given arguments are nil or the field metadata array is empty.

- (BOOL) isEqualToRecordMetadata: (nullable PTDiffusionRecordMetadata *) recordMetadata

Compares the receiver to the given record metadata.

Parameters

recordMetadata The record metadata object with which to compare the receiver.

Returns: YES if the record metadata is equal to the receiver, otherwise NO.

- (NSArray<__kindof PTDiffusionFieldMetadata *>*) fieldMetadata

readnonatomiccopy

The field metadata used to transform records using the receiver. This array may not be empty.