RLM 컬렉션

Objective-C

@protocol RLMCollection <NSFastEnumeration, RLMThreadConfined>

Swift

protocol RLMCollection : NSFastEnumeration, RLMThreadConfined

Realm에서 관리하는 객체의 동종 컬렉션입니다. 준수 유형의 예로는 RLMArray, RLMSet, RLMResultsRLMLinkingObjects 등이 있습니다.

속성

  • collection의 객체 수입니다.

    선언

    Objective-C

    @property (nonatomic, readonly) NSUInteger count;

    Swift

    var count: UInt { get }
  • 컬렉션에 있는 객체의 유형입니다.

    선언

    Objective-C

    @property (nonatomic, readonly) RLMPropertyType type;

    Swift

    var type: RLMPropertyType { get }
  • collection의 객체가 nil 일 수 있는지 여부를 나타냅니다.

    선언

    Objective-C

    @property (nonatomic, readonly, getter=isOptional) BOOL optional;

    Swift

    var isOptional: Bool { get }
  • 컬렉션에 포함된 객체의 클래스 이름입니다.

    type 이(가) RLMPropertyTypeObject가 아닌 경우 nil 이(가) 됩니다.

    선언

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *objectClassName;

    Swift

    var objectClassName: String? { get }
  • 이 컬렉션 을 관리하는 Realm (있는 경우)입니다.

    선언

    Objective-C

    @property (nonatomic, readonly, nullable) RLMRealm *realm;

    Swift

    var realm: RLMRealm? { get }
  • 컬렉션이 더 이상 유효하지 않은지 여부를 나타냅니다.

    관리 Realm에서 invalidate 가 호출되면 컬렉션이 유효하지 않게 됩니다. 관리되지 않는 컬렉션은 무효화되지 않습니다.

    선언

    Objective-C

    @property (nonatomic, readonly, getter=isInvalidated) BOOL invalidated;

    Swift

    var isInvalidated: Bool { get }

컬렉션에서 객체 액세스

  • 지정된 인덱스에 있는 객체를 반환합니다.

    선언

    Objective-C

    - (nonnull id)objectAtIndex:(NSUInteger)index;

    Swift

    func object(at index: UInt) -> Any

    매개변수

    index

    조회할 인덱스입니다.

    반환 값

    컬렉션에 포함된 형식의 객체입니다.

  • 지정된 인덱스 세트로 지정된 인덱스에 있는 컬렉션의 객체를 포함하는 배열을 반환합니다. 인덱스 세트에 컬렉션 범위를 벗어난 인덱스가 포함된 경우 nil 이 반환됩니다.

    선언

    Objective-C

    - (nullable NSArray *)objectsAtIndexes:(nonnull NSIndexSet *)indexes;

    Swift

    optional func objects(at indexes: IndexSet) -> [Any]?

    매개변수

    indexes

    객체를 검색할 컬렉션의 인덱스입니다.

    반환 값

    지정된 인덱스에 있는 객체입니다.

  • 컬렉션의 첫 번째 객체를 반환합니다.

    RLMSet는 순서가 지정되지 않으므로 세트의 경우 설정하다 내 임의의 객체 를 반환합니다. 설정하다 에 여러 객체가 있더라도 lastObject 가 제공하는 것과 다른 객체 가 보장되지는 않습니다.

    빈 컬렉션 에서 호출되면 nil 를 반환합니다.

    선언

    Objective-C

    - (nullable id)firstObject;

    Swift

    optional func firstObject() -> Any?

    반환 값

    컬렉션에 포함된 형식의 객체입니다.

  • 컬렉션 의 마지막 객체 를 반환합니다.

    RLMSet는 순서가 지정되지 않으므로 세트의 경우 설정하다 내 임의의 객체 를 반환합니다. 설정하다 에 여러 객체가 있더라도 firstObject 가 제공하는 것과 다른 객체 가 보장되지는 않습니다.

    빈 컬렉션 에서 호출되면 nil 를 반환합니다.

    선언

    Objective-C

    - (nullable id)lastObject;

    Swift

    optional func lastObject() -> Any?

    반환 값

    컬렉션에 포함된 형식의 객체입니다.

  • 컬렉션 에 있는 객체 의 인덱스 를 반환합니다.

    컬렉션에서 객체를 찾을 수 없는 경우 NSNotFound 를 반환합니다.

    선언

    Objective-C

    - (NSUInteger)indexOfObject:(nonnull id)object;

    Swift

    optional func index(of object: Any) -> UInt

    매개변수

    object

    객체( objectClassName 선택기에서 반환된 것과 동일한 유형)입니다.

  • collection에서 조건자와 일치하는 첫 번째 객체의 인덱스를 반환합니다.

    선언

    Objective-C

    - (NSUInteger)indexOfObjectWhere:(nonnull NSString *)predicateFormat, ...;

    매개변수

    predicateFormat

    조건자 형식 문자열이며, 선택적으로 그 뒤에 다양한 수의 인수가 옵니다.

    반환 값

    객체의 인덱스이거나 컬렉션에서 객체를 찾을 수 없는 경우 NSNotFound 입니다.

  • collection에서 조건자와 일치하는 첫 번째 객체의 인덱스를 반환합니다.

    선언

    Objective-C

    - (NSUInteger)indexOfObjectWithPredicate:(nonnull NSPredicate *)predicate;

    Swift

    optional func indexOfObject(with predicate: NSPredicate) -> UInt

    매개변수

    predicate

    객체를 필터링하는 데 사용할 조건자입니다.

    반환 값

    객체의 인덱스이거나 컬렉션에서 객체를 찾을 수 없는 경우 NSNotFound 입니다.

컬렉션 쿼리

  • collection에서 지정된 조건자와 일치하는 모든 객체를 반환합니다.

    이는 관리되는 컬렉션에 대해서만 지원됩니다.

    선언

    Objective-C

    - (nonnull RLMResults *)objectsWhere:(nonnull NSString *)predicateFormat, ...;

    매개변수

    predicateFormat

    조건자 형식 문자열이며, 선택적으로 그 뒤에 다양한 수의 인수가 옵니다.

    반환 값

    지정된 조건자와 일치하는 객체를 포함하는 RLMResults 입니다.

  • collection에서 지정된 조건자와 일치하는 모든 객체를 반환합니다.

    이는 관리되는 컬렉션에 대해서만 지원됩니다.

    선언

    Objective-C

    - (nonnull RLMResults *)objectsWithPredicate:(nonnull NSPredicate *)predicate;

    Swift

    func objects(with predicate: NSPredicate) -> RLMResults

    매개변수

    predicate

    객체를 필터링하는 데 사용할 조건자입니다.

    반환 값

    지정된 조건자와 일치하는 객체를 포함하는 RLMResults 입니다.

  • 컬렉션 에서 정렬된 RLMResults 를 반환합니다.

    이는 관리되는 컬렉션에 대해서만 지원됩니다.

    선언

    Objective-C

    - (nonnull RLMResults *)sortedResultsUsingKeyPath:(nonnull NSString *)keyPath
                                            ascending:(BOOL)ascending;

    Swift

    func sortedResults(usingKeyPath keyPath: String, ascending: Bool) -> RLMResults

    매개변수

    keyPath

    정렬 기준으로 사용할 keyPath입니다.

    ascending

    정렬할 방향입니다.

    반환 값

    지정된 키 경로를 기준으로 정렬된 RLMResults 입니다.

  • 컬렉션 에서 정렬된 RLMResults 를 반환합니다.

    이는 관리되는 컬렉션에 대해서만 지원됩니다.

    선언

    Objective-C

    - (nonnull RLMResults *)sortedResultsUsingDescriptors:
        (nonnull NSArray<RLMSortDescriptor *> *)properties;

    Swift

    func sortedResults(using properties: [RLMSortDescriptor]) -> RLMResults

    매개변수

    properties

    정렬 기준이 되는 RLMSortDescriptor의 배열입니다.

    반환 값

    지정된 속성을 기준으로 정렬된 RLMResults 입니다.

  • 컬렉션에서 고유한 RLMResults 를 반환합니다.

    이는 관리되는 컬렉션에 대해서만 지원됩니다.

    선언

    Objective-C

    - (nonnull RLMResults *)distinctResultsUsingKeyPaths:
        (nonnull NSArray<NSString *> *)keyPaths;

    Swift

    func distinctResults(usingKeyPaths keyPaths: [String]) -> RLMResults

    매개변수

    keyPaths

    사용된 주요 경로는 뚜렷한 결과를 냅니다.

    반환 값

    지정된 키 경로를 기반으로 구분되는 RLMResults 입니다.

  • 컬렉션의 각 객체에 대해 를 NSArray 사용하여 를 호출한 결과가 포함된 valueForKey: 을 반환합니다.key

    선언

    Objective-C

    - (nullable id)valueForKey:(nonnull NSString *)key;

    Swift

    func value(forKey key: String) -> Any?

    매개변수

    key

    속성의 이름입니다.

    반환 값

    결과가 포함된 NSArray 입니다.

  • 지정된 키 경로로 식별되는 파생 속성의 값을 반환합니다.

    선언

    Objective-C

    - (nullable id)valueForKeyPath:(nonnull NSString *)keyPath;

    Swift

    func value(forKeyPath keyPath: String) -> Any?

    매개변수

    keyPath

    관계.property 형식의 키 경로(하나 이상의 관계 포함)입니다.

    반환 값

    keyPath로 식별되는 파생 속성의 값입니다.

  • 지정된 valuekey 를 사용하여 컬렉션의 각 객체에 대해 setValue:forKey: 을(를) 호출합니다.

    경고

    이 메서드는 쓰기 트랜잭션(write transaction) 중에만 호출할 수 있습니다.

    선언

    Objective-C

    - (void)setValue:(nullable id)value forKey:(nonnull NSString *)key;

    Swift

    func setValue(_ value: Any?, forKey key: String)

    매개변수

    value

    객체 값입니다.

    key

    속성의 이름입니다.

알림

  • collection이 변경될 때마다 호출될 블록을 등록합니다.

    차단 은 초기 컬렉션 과 비동기적으로 호출된 다음 컬렉션 의 객체 또는 컬렉션 에 있는 객체를 변경하는 각 쓰기 트랜잭션 (write transaction) (write transaction) 후에 다시 호출됩니다.

    블록이 처음 호출될 때 change 매개변수는 nil 이(가) 됩니다. 그 이후의 각 호출에 대해 컬렉션의 어떤 행이 추가, 제거 또는 수정되었는지에 대한 정보가 포함됩니다. 쓰기 트랜잭션(write transaction)이 결과 컬렉션의 객체를 수정하지 않은 경우 블록은 전혀 호출되지 않습니다. 변경 사항이 보고되는 방법과 UITableView 업데이트의 예에 대한 자세한 내용은 RLMCollectionChange 설명서를 참조하세요.

    오류 매개변수는 이전 버전과의 호환성을 위해서만 존재하며 항상 nil 입니다.

    차단이 호출되는 시점에 컬렉션 객체는 완전히 평가되고 최신 상태가 되며, 동일한 스레드에서 쓰기 트랜잭션(write transaction)을 수행하지 않거나 명시적으로 -[RLMRealm refresh] 을(를) 호출하지 않는 한 해당 객체에 액세스하는 것은 절대 수행되지 않습니다. 차단 작업.

    알림은 표준 이벤트 루프를 통해 전달되므로 다른 활동으로 이벤트 루프가 차단된 동안에는 전달할 수 없습니다. 알림을 즉시 전달할 수 없는 경우 여러 알림이 단일 알림으로 병합될 수 있습니다. 여기에는 초기 결과에 대한 알림이 포함될 수 있습니다. 예를 들어 다음 코드는 알림 차단을 추가한 직후 쓰기 트랜잭션(write transaction)을 수행하므로 초기 알림이 먼저 전달될 기회가 없습니다. 결과적으로 초기 알림에는 쓰기 트랜잭션(write transaction) 후 Realm의 상태가 반영됩니다.

    RLM 결과 *results = [Dog allObjects]; NSLog(@"dogs.count: %zu", dogs.count); // => 0 self.token = [results addNotificationBlock:^(RLMResults *dogs, RLMCollectionChange *changes, NSError *error) { // 예제에서는 한 번만 실행 NSLog(@"dogs.count: %zu" , dogs.count); // => 1 }]; [realm transactionWithBlock:^{ Dog *dog = [[Dog alloc] init]; dog.name = @"Rex"; [realm addObject:dog]; }]; // 런 루프 실행 컨텍스트의 끝

    업데이트를 해당 블록에 계속 전송하려면 반환된 토큰을 오랫동안 보관해야 합니다. 업데이트 수신을 중지하려면 토큰에서 -invalidate 을 호출합니다.

    경고

    쓰기 트랜잭션(write transaction) 중에는 또는 포함하는 Realm이 읽기 전용이거나 동결된 경우에는 이 메서드를 호출할 수 없습니다.

    선언

    Objective-C

    - (nonnull RLMNotificationToken *)addNotificationBlock:
        (nonnull void (^)(RLMResults *_Nullable, RLMCollectionChange *_Nullable,
                          NSError *_Nullable))block;

    Swift

    func addNotificationBlock(_ block: @escaping (RLMResults?, RLMCollectionChange?, (any Error)?) -> Void) -> RLMNotificationToken

    매개변수

    block

    변경이 발생할 때마다 호출되는 차단입니다.

    반환 값

    업데이트가 전달되기를 원하는 기간 동안 보유해야 하는 토큰입니다.

  • collection이 변경될 때마다 호출될 블록을 등록합니다.

    차단 은 초기 컬렉션 과 비동기적으로 호출된 다음 컬렉션 의 객체 또는 컬렉션 에 있는 객체를 변경하는 각 쓰기 트랜잭션 (write transaction) (write transaction) 후에 다시 호출됩니다.

    블록이 처음 호출될 때 change 매개변수는 nil 이(가) 됩니다. 그 이후의 각 호출에 대해 컬렉션의 어떤 행이 추가, 제거 또는 수정되었는지에 대한 정보가 포함됩니다. 쓰기 트랜잭션(write transaction)이 결과 컬렉션의 객체를 수정하지 않은 경우 블록은 전혀 호출되지 않습니다. 변경 사항이 보고되는 방법과 UITableView 업데이트의 예에 대한 자세한 내용은 RLMCollectionChange 설명서를 참조하세요.

    오류 매개변수는 이전 버전과의 호환성을 위해서만 존재하며 항상 nil 입니다.

    차단이 호출되는 시점에 컬렉션 객체는 완전히 평가되고 최신 상태가 되며, 동일한 스레드에서 쓰기 트랜잭션(write transaction)을 수행하지 않거나 명시적으로 -[RLMRealm refresh] 을(를) 호출하지 않는 한 해당 객체에 액세스하는 것은 절대 수행되지 않습니다. 차단 작업.

    알림은 지정된 대기열에 전달됩니다. 대기열이 차단되어 알림을 즉시 전달할 수 없는 경우 여러 알림이 단일 알림으로 병합될 수 있습니다.

    업데이트를 해당 블록에 계속 전송하려면 반환된 토큰을 오랫동안 보관해야 합니다. 업데이트 수신을 중지하려면 토큰에서 -invalidate 을 호출합니다.

    경고

    포함하는 Realm이 읽기 전용이거나 동결된 경우에는 이 메서드를 호출할 수 없습니다.

    경고

    대기열은 직렬 대기열이어야 합니다.

    선언

    Objective-C

    - (nonnull RLMNotificationToken *)
        addNotificationBlock:(nonnull void (^)(RLMResults *_Nullable,
                                               RLMCollectionChange *_Nullable,
                                               NSError *_Nullable))block
                       queue:(nullable dispatch_queue_t)queue;

    Swift

    func addNotificationBlock(_ block: @escaping (RLMResults?, RLMCollectionChange?, (any Error)?) -> Void, queue: dispatch_queue_t?) -> RLMNotificationToken

    매개변수

    block

    변경이 발생할 때마다 호출되는 차단입니다.

    queue

    알림을 전달할 직렬 대기열입니다.

    반환 값

    업데이트가 전달되기를 원하는 기간 동안 보유해야 하는 토큰입니다.

  • collection이 변경될 때마다 호출될 블록을 등록합니다.

    차단 은 초기 컬렉션 과 비동기적으로 호출된 다음 컬렉션 의 객체 또는 컬렉션 에 있는 객체를 변경하는 각 쓰기 트랜잭션 (write transaction) (write transaction) 후에 다시 호출됩니다.

    블록이 처음 호출될 때 change 매개변수는 nil 이(가) 됩니다. 그 이후의 각 호출에 대해 컬렉션의 어떤 행이 추가, 제거 또는 수정되었는지에 대한 정보가 포함됩니다. 쓰기 트랜잭션(write transaction)이 결과 컬렉션의 객체를 수정하지 않은 경우 블록은 전혀 호출되지 않습니다. 변경 사항이 보고되는 방법과 UITableView 업데이트의 예에 대한 자세한 내용은 RLMCollectionChange 설명서를 참조하세요.

    오류 매개변수는 이전 버전과의 호환성을 위해서만 존재하며 항상 nil 입니다.

    차단이 호출되는 시점에 컬렉션 객체는 완전히 평가되고 최신 상태가 되며, 동일한 스레드에서 쓰기 트랜잭션(write transaction)을 수행하지 않거나 명시적으로 -[RLMRealm refresh] 을(를) 호출하지 않는 한 해당 객체에 액세스하는 것은 절대 수행되지 않습니다. 차단 작업.

    알림은 지정된 대기열에 전달됩니다. 대기열이 차단되어 알림을 즉시 전달할 수 없는 경우 여러 알림이 단일 알림으로 병합될 수 있습니다.

    업데이트를 해당 블록에 계속 전송하려면 반환된 토큰을 오랫동안 보관해야 합니다. 업데이트 수신을 중지하려면 토큰에서 -invalidate 을 호출합니다.

    경고

    포함하는 Realm이 읽기 전용이거나 동결된 경우에는 이 메서드를 호출할 수 없습니다.

    경고

    대기열은 직렬 대기열이어야 합니다.

    선언

    Objective-C

    - (nonnull RLMNotificationToken *)
        addNotificationBlock:(nonnull void (^)(RLMResults *_Nullable,
                                               RLMCollectionChange *_Nullable,
                                               NSError *_Nullable))block
                    keyPaths:(nullable NSArray<NSString *> *)keyPaths
                       queue:(nullable dispatch_queue_t)queue;

    Swift

    func addNotificationBlock(_ block: @escaping (RLMResults?, RLMCollectionChange?, (any Error)?) -> Void, keyPaths: [String]?, queue: dispatch_queue_t?) -> RLMNotificationToken

    매개변수

    block

    변경이 발생할 때마다 호출되는 차단입니다.

    queue

    알림을 전달할 직렬 대기열입니다.

    keyPaths

    이러한 키 경로에서 발생하는 변경에 대해 차단이 호출됩니다. 키 경로가 제공되지 않으면 모든 속성 키 경로에 대해 알림이 전달됩니다.

    반환 값

    업데이트가 전달되기를 원하는 기간 동안 보유해야 하는 토큰입니다.

섹션별 결과

속성 값 집계

  • 컬렉션에 있는 모든 객체 중 지정된 속성의 최소값(가장 낮은 값)을 반환합니다.

    NSNumber *min = [results minOfProperty:@"age"];
    

    경고

    RLMObject, RLMArrayNSData 속성에서는 이 메서드를 사용할 수 없습니다.

    선언

    Objective-C

    - (nullable id)minOfProperty:(nonnull NSString *)property;

    Swift

    func min(ofProperty property: String) -> Any?

    매개변수

    property

    The property whose minimum value is desired. int, float, doubleNSDate 유형의 속성만 지원됩니다.

    반환 값

    속성의 최소값이거나 결과가 비어 있는 경우 nil 입니다.

  • 컬렉션에 있는 모든 객체 중 지정된 속성의 최대값(가장 높은 값)을 반환합니다.

    NSNumber *max = [results maxOfProperty:@"age"];
    

    경고

    RLMObject, RLMArrayNSData 속성에서는 이 메서드를 사용할 수 없습니다.

    선언

    Objective-C

    - (nullable id)maxOfProperty:(nonnull NSString *)property;

    Swift

    func max(ofProperty property: String) -> Any?

    매개변수

    property

    The property whose maximum value is desired. int, float, doubleNSDate 유형의 속성만 지원됩니다.

    반환 값

    속성의 최대값이거나 결과가 비어 있는 경우 nil 입니다.

  • 컬렉션의 모든 객체에 대해 지정된 속성 값의 합계를 반환합니다.

    NSNumber *sum = [results sumOfProperty:@"age"];
    

    경고

    RLMObject, RLMArrayNSData 속성에서는 이 메서드를 사용할 수 없습니다.

    선언

    Objective-C

    - (nonnull NSNumber *)sumOfProperty:(nonnull NSString *)property;

    Swift

    func sum(ofProperty property: String) -> NSNumber

    매개변수

    property

    값을 합산해야 하는 속성입니다. int, floatdouble 유형의 속성만 지원됩니다.

    반환 값

    지정된 속성의 합계입니다.

  • 컬렉션의 객체에 대한 지정된 속성의 평균값을 반환합니다.

    NSNumber *average = [results averageOfProperty:@"age"];
    

    경고

    RLMObject, RLMArrayNSData 속성에서는 이 메서드를 사용할 수 없습니다.

    선언

    Objective-C

    - (nullable NSNumber *)averageOfProperty:(nonnull NSString *)property;

    Swift

    func average(ofProperty property: String) -> NSNumber?

    매개변수

    property

    평균값을 계산해야 하는 속성입니다. int, floatdouble 유형의 속성만 지원됩니다.

    반환 값

    지정된 속성의 평균값이거나 결과가 비어 있는 경우 nil 입니다.

동결

  • 컬렉션이 동결되었는지 여부를 나타냅니다.

    동결된 컬렉션은 변경할 수 없으며 모든 스레드에서 액세스할 수 있습니다. 동결된 컬렉션에서 읽은 객체도 동결됩니다.

    선언

    Objective-C

    @required
    @property (nonatomic, readonly, getter=isFrozen) BOOL frozen;

    Swift

    var isFrozen: Bool { get }
  • 이 collection의 동결(불변) 스냅샷을 반환합니다.

    동결 사본은 변경이 불가능한 collection으로 이 collection이 현재 포함하고 있는 것과 동일한 데이터를 포함하지만 포함 Realm에 기록할 때 업데이트되지 않습니다. 라이브 collection과 달리 동결 collection은 모든 스레드에서 액세스할 수 있습니다.

    경고

    쓰기 트랜잭션(write transaction) 중에는 또는 포함하는 Realm이 읽기 전용일 때 이 메서드를 호출할 수 없습니다.

    경고

    Realm에서 쓰기 트랜잭션(write transaction)을 수행하는 동안 동결된 컬렉션을 오랫동안 유지하면 Realm 파일 크기가 커질 수 있습니다. 자세한 내용은 RLMRealmConfiguration.maximumNumberOfActiveVersions 를 참조하세요.

    선언

    Objective-C

    - (nonnull instancetype)freeze;

    Swift

    func freeze() -> Self
  • 이 동결된 collection의 라이브 버전을 반환합니다.

    이 메서드는 동일한 동결 컬렉션의 라이브 사본에 대한 참조를 확인합니다. 라이브 컬렉션에서 호출하면 자체를 반환합니다.

    선언

    Objective-C

    - (nonnull instancetype)thaw;

    Swift

    func thaw() -> Self