PTDiffusionRecord Class Reference

Introduction

A record is a collection of fields.

A record object is immutable.

See Also

PTDiffusionRecordContent

PTDiffusionRecordMetadata

Since

5.6

Inheritance diagram for PTDiffusionRecord:

Properties
NSData *	data
PTDiffusionRecordMetadata *	metadata
NSArray< PTDiffusionField * > *	fields

Instance Methods
(NSArray< PTDiffusionField * > *)	- fieldsWithName:
(nullable PTDiffusionField *)	- fieldWithName:
(BOOL)	- isEqualToRecord:

Method Documentation

- (NSArray<PTDiffusionField *> *) fieldsWithName:

(NSString *)

name

Returns fields transformed by a PTDiffusionFieldMetadata object with the given name.

If no fields were found with the given name or metadata is nil then this method will return an empty array.

Parameters

name	The name to find when examining metadata to select fields.

Exceptions

NSInvalidArgumentException

If the given name is nil.

Since

5.6

- (nullable PTDiffusionField *) fieldWithName:

(NSString *)

name

Returns the first field object transformed by a PTDiffusionFieldMetadata object with the given name.

If no fields were found with the given name or metadata is nil then this method will return nil.

Parameters

name	The name to find when examining metadata to select field.

Exceptions

NSInvalidArgumentException

If the given name is nil.

Since

5.6

- (BOOL) isEqualToRecord:

(nullable PTDiffusionRecord *)

record

Compares the receiver to the given record.

Parameters

record

The record object with which to compare the receiver.

Returns

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

Since

5.6

Property Documentation

- (NSData*) data

readnonatomiccopy

The data defining the receiver. This returns the raw underlying bytes. It has not been transformed in any way.

Since

5.6

- (NSArray<PTDiffusionField *>*) fields

readnonatomicassign

Returns all fields encapsulated by the receiver. This array may be empty.

Since

5.6

- (PTDiffusionRecordMetadata*) metadata

readnonatomiccopy

The metadata defining the transformation applied to the receiver's data to produce the fields.

Since

5.6