PTDiffusionStringFieldMetadata Class Reference

Introduction

String field metadata describes a data item that can have a textual value.

A string 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 PTDiffusionStringFieldMetadata:

Class Methods
(NSString *)	+ defaultDefaultValue
Class Methods inherited from PTDiffusionFieldMetadata
(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
NSString *	defaultValue
Properties inherited from PTDiffusionFieldMetadata
Class< NSObject, NSCopying, NSSecureCoding >	valueClass
Properties inherited from PTDiffusionMetadata
NSString *	name
PTDiffusionMultiplicity *	multiplicity

Instance Methods
(instancetype)	- initWithName:multiplicity:
(instancetype)	- initWithName:defaultValue:multiplicity:
(BOOL)	- isEqualToStringFieldMetadata:
Instance Methods inherited from PTDiffusionFieldMetadata
(BOOL)	- isEqualToFieldMetadata:
Instance Methods inherited from PTDiffusionMetadata
(BOOL)	- isEqualToMetadata:

Method Documentation

+ (NSString *) defaultDefaultValue

The default value used if one is not explicitly specified on initialisation.

Returns

An empty string.

Since

5.7.1

- (instancetype) initWithName:		(NSString *)	name
defaultValue:		(nullable 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 that required occurrences of the field should be initialized to. Specifying nil for this argument uses an empty string (as specified by the defaultDefaultValue class method).
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.7.1

- (instancetype) initWithName:		(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

- (BOOL) isEqualToStringFieldMetadata:

(nullable PTDiffusionStringFieldMetadata *)

stringFieldMetadata

Compares the receiver to the given string field metadata.

Parameters

stringFieldMetadata

The string field metadata object with which to compare the receiver.

Returns

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

Since

5.6

Property Documentation

- (NSString*) defaultValue

readnonatomicassign

The default value that required occurrences of the field should be initialized to.

Since

5.7.1