PTDiffusionFieldMetadata Class Reference

Introduction

Field metadata describes a data item that can have a value.

A field metadata object is immutable.

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

See Also

PTDiffusionRecordMetadata

Since

5.6

Inheritance diagram for PTDiffusionFieldMetadata:

Class Methods
(PTDiffusionStringFieldMetadata *)	+ defaultMetadata
(PTDiffusionStringFieldMetadata *)	+ stringWithName:
(PTDiffusionStringFieldMetadata *)	+ stringWithName:multiplicity:
(PTDiffusionStringFieldMetadata *)	+ stringWithName:defaultValue:multiplicity:
(PTDiffusionNumberFieldMetadata *)	+ numberWithName:
(PTDiffusionNumberFieldMetadata *)	+ numberWithName:multiplicity:
(PTDiffusionNumberFieldMetadata *)	+ numberWithName:scale:
(PTDiffusionNumberFieldMetadata *)	+ numberWithName:multiplicity:scale:
(PTDiffusionNumberFieldMetadata *)	+ numberWithName:defaultValue:multiplicity:scale:

Properties
Class< NSObject, NSCopying, NSSecureCoding >	valueClass
Properties inherited from PTDiffusionMetadata
NSString *	name
PTDiffusionMultiplicity *	multiplicity

Instance Methods
(BOOL)	- isEqualToFieldMetadata:
Instance Methods inherited from PTDiffusionMetadata
(BOOL)	- isEqualToMetadata:

Method Documentation

+ (PTDiffusionStringFieldMetadata *) defaultMetadata

Returns default field metadata, representing a string field with unbounded multiplicity.

Since

5.7

- (BOOL) isEqualToFieldMetadata:

(nullable PTDiffusionFieldMetadata *)

fieldMetadata

Compares the receiver to the given field metadata.

Parameters

fieldMetadata

The field metadata object with which to compare the receiver.

Returns

YES if the field metadata is equal to the receiver, otherwise NO.

Since

5.6

+ (PTDiffusionNumberFieldMetadata *) numberWithName:

(NSString *)

name

Returns a number field metadata object initialized with the given name, default multiplicity and default scale.

Parameters

name	The name to use. It is used when looking up fields that have been transformed using the receiver.

Exceptions

NSInvalidArgumentException

If the given name is nil.

Since

5.6

+ (PTDiffusionNumberFieldMetadata *) numberWithName:		(NSString *)	name
defaultValue:		(NSNumber *)	defaultValue
multiplicity:		(PTDiffusionMultiplicity *)	multiplicity
scale:		(NSUInteger)	scale

Returns a number field metadata object initialized with the given name, given default value, given scale and given multiplicity.

Parameters

name	The name to use. It is used when looking up fields that have been transformed using the receiver.
defaultValue	The default value to use for this field if one is not specified.
multiplicity	The multiplicity to use. It governs how many fields can be transformed using the receiver from the enclosing record.
scale	The scale to use. It governs how many digits lie to the right of the decimal point. A value of zero (0) constrains transformed fields to integer values.

Exceptions

NSInvalidArgumentException

If either the given name, defaultValue or multiplicity is nil.

Since

5.7.1

+ (PTDiffusionNumberFieldMetadata *) numberWithName:		(NSString *)	name
multiplicity:		(PTDiffusionMultiplicity *)	multiplicity

Returns a number field metadata object initialized with the given name, default scale and given multiplicity.

Parameters

name	The name to use. It is used when looking up fields that have been transformed using the receiver.
multiplicity	The multiplicity to use. It governs how many fields can be transformed using the receiver from the enclosing record.

Exceptions

NSInvalidArgumentException

If either the given name or multiplicity is nil.

Since

5.6

+ (PTDiffusionNumberFieldMetadata *) numberWithName:		(NSString *)	name
multiplicity:		(PTDiffusionMultiplicity *)	multiplicity
scale:		(NSUInteger)	scale

Returns a number field metadata object initialized with the given name, given scale and given multiplicity.

Parameters

name	The name to use. It is used when looking up fields that have been transformed using the receiver.
multiplicity	The multiplicity to use. It governs how many fields can be transformed using the receiver from the enclosing record.
scale	The scale to use. It governs how many digits lie to the right of the decimal point. A value of zero (0) constrains transformed fields to integer values.

Exceptions

NSInvalidArgumentException

If either the given name or multiplicity is nil.

Since

5.6

+ (PTDiffusionNumberFieldMetadata *) numberWithName:		(NSString *)	name
scale:		(NSUInteger)	scale

Returns a number field metadata object initialized with the given name, given scale and default multiplicity.

Parameters

name	The name to use. It is used when looking up fields that have been transformed using the receiver.
scale	The scale to use. It governs how many digits lie to the right of the decimal point. A value of zero (0) constrains transformed fields to integer values.

Exceptions

NSInvalidArgumentException

If the given name is nil.

Since

5.6

+ (PTDiffusionStringFieldMetadata *) stringWithName:

(NSString *)

name

Returns a string field metadata object initialized with the given name and default multiplicity.

Parameters

name	The name to use. It is used when looking up fields that have been transformed using the receiver.

Exceptions

NSInvalidArgumentException

If the given name is nil.

Since

5.6

+ (PTDiffusionStringFieldMetadata *) stringWithName:		(NSString *)	name
defaultValue:		(NSString *)	defaultValue
multiplicity:		(PTDiffusionMultiplicity *)	multiplicity

Returns a string field metadata object initialized with the given name, given default value and given multiplicity.

Parameters

name	The name to use. It is used when looking up fields that have been transformed using the receiver.
defaultValue	The default value to use for this field if one is not specified.
multiplicity	The multiplicity to use. It governs how many fields can be transformed using the receiver from the enclosing record.

Exceptions

NSInvalidArgumentException

If any given argument is nil.

Since

5.7.1

+ (PTDiffusionStringFieldMetadata *) stringWithName:		(NSString *)	name
multiplicity:		(PTDiffusionMultiplicity *)	multiplicity

Returns a string field metadata object initialized with the given name and multiplicity.

Parameters

name	The name to use. It is used when looking up fields that have been transformed using the receiver.
multiplicity	The multiplicity to use. It governs how many fields can be transformed using the receiver from the enclosing record.

Exceptions

NSInvalidArgumentException

If either the given name or multiplicity is nil.

Since

5.6

Property Documentation

- (Class<NSObject, NSCopying, NSSecureCoding>) valueClass

readnonatomicassign

The class of object produced when transforming field data using the receiver.

Since

5.6