PTDiffusionField Class Reference

Introduction

A field represents a single value in a record.

A field object is immutable.

See Also

PTDiffusionRecord

PTDiffusionFieldMetadata

Since

5.6

Inheritance diagram for PTDiffusionField:

Properties
NSData *	data
PTDiffusionFieldMetadata *	metadata
id< NSObject, NSCopying, NSSecureCoding >	value

Instance Methods
(BOOL)	- isEqualToField:

Method Documentation

- (BOOL) isEqualToField:

(nullable PTDiffusionField *)

field

Compares the receiver to the given field.

Parameters

field

The field object with which to compare the receiver.

Returns

YES if the field 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

- (PTDiffusionFieldMetadata*) metadata

readnonatomiccopy

The metadata defining the transformation that was applied to the receiver's data to produce the value.

Since

5.6

- (id<NSObject, NSCopying, NSSecureCoding>) value

readnonatomiccopy

The value produced by applying the metadata to the data. If metadata is nil then this will return nil.

The metadata defines the class of object returned by this method:

• An NSString will be returned when transformed using PTDiffusionStringFieldMetadata.
• Either an NSNumber or NSDecimalNumber will be returned when transformed using PTDiffusionNumberFieldMetadata, depending on the metadata's scale.

Since

5.6