RealmKeyedCollection

public protocol RealmKeyedCollection : ThreadConfined, CustomStringConvertible, Sequence

검색, 필터링, 정렬 및 연산이 가능한 Object의 동질적인 키-값 collection입니다.

속성

  • 지도를 managed Realm이거나 지도가 관리되지 않는 경우 nil 입니다.

    선언

    Swift

    var realm: Realm? { get }
  • 지도에 더 이상 액세스할 수 없는지 여부를 나타냅니다.

    선언

    Swift

    var isInvalidated: Bool { get }
  • 이 맵에 있는 키-값 쌍의 수를 반환합니다.

    선언

    Swift

    var count: Int { get }
  • 지도에 포함된 객체에 대한 사람이 읽을 수 있는 설명입니다.

    선언

    Swift

    var description: String { get }

변형

  • 지정된 키에 대해 딕셔너리에 저장된 값을 업데이트하거나 키가 존재하지 않는 경우 새 키-값 쌍을 추가합니다.

    참고

    참고:사전에 추가되는 값이 관리되지 않는 객체 이고 딕셔너리가 managed 경우 관리되지 않는 객체 는 Realm 에 추가됩니다.

    경고

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

    선언

    Swift

    func updateValue(_ value: Value, forKey key: Key)

    매개변수

    value

    값의 키 경로 술어입니다.

    forKey

    정렬할 방향입니다.

  • 키가 사전에 있는 경우에만 지정된 키와 관련 객체 를 제거합니다. 키가 존재하지 않으면 사전이 수정되지 않습니다.

    경고

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

    선언

    Swift

    func removeObject(for key: Key)
  • 딕셔너리에서 모든 객체를 제거합니다. 객체는 해당 객체를 관리하는 Realm 에서 제거되지 않습니다.

    경고

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

    선언

    Swift

    func removeAll()
  • 주어진 키에 대한 값을 반환하거나, 할당에 아래 첨자를 사용하는 경우 키의 값을 설정합니다.

    참고

    참고:사전에 추가되는 값이 관리되지 않는 객체 이고 딕셔너리가 managed 경우 관리되지 않는 객체 는 Realm 에 추가됩니다.

    참고

    참고: 키에 할당되는 값이 nil 인 경우 해당 키가 사전에서 제거됩니다.

    경고

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

    선언

    Swift

    subscript(key: Key) -> Value? { get set }

    매개변수

    key

    키입니다.

KVC

  • 지정된 키가 지도에 있는 경우 해당 키에 대한 Value 유형을 반환합니다.

    키-값 코딩을 사용할 때 키는 문자열이어야 합니다.

    선언

    Swift

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

    매개변수

    key

    값을 구하려는 속성의 키입니다.

  • 지정된 키가 지도에 있는 경우 해당 키에 대한 Value 유형을 반환합니다.

    선언

    Swift

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

    매개변수

    keyPath

    값을 구하려는 속성의 키입니다.

  • 지정된 키-값 쌍을 사전에 추가하거나 지정된 키가 이미 존재하는 경우 업데이트합니다.

    경고

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

    선언

    Swift

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

    매개변수

    value

    객체 값입니다.

    key

    각 객체에 값을 설정해야 하는 속성의 이름입니다.

필터링

  • 주어진 조건자와 사전에서 일치하는 모든 값을 포함하는 Results 를 반환합니다.

    참고

    이렇게 하면 키-값 쌍이 아닌 딕셔너리의 값을 반환합니다.

    선언

    Swift

    func filter(_ predicate: NSPredicate) -> Results<Value>

    매개변수

    predicate

    값을 필터링할 조건자입니다.

  • 맵에 포함된 키-값 쌍이 지정된 조건자를 충족하는지 여부를 나타내는 부울 값을 반환합니다.

    선언

    Swift

    func contains(where predicate: @escaping (_ key: Key, _ value: Value) -> Bool) -> Bool

    매개변수

    where

    지정된 맵의 키 쌍이 일치하는 항목을 나타내는지 테스트하는 클로저입니다.

정렬

  • 사전에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    객체는 해당 값을 기준으로 정렬됩니다. 예를 예시 Date의 사전을 최신 세트에서 가장 오래된 것 순으로 정렬하려면 dates.sorted(ascending: true) 호출할 수 있습니다.

    선언

    Swift

    func sorted(ascending: Bool) -> Results<Value>

    매개변수

    ascending

    정렬할 방향입니다.

  • 사전에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    객체는 지정된 키 경로의 값을 기준으로 정렬됩니다. 예를 예시 age 속성 을 기준으로 Student사전을 가장 오래된 것부터 오래된 것 순으로 정렬하려면 students.sorted(byKeyPath: "age", ascending: true) 를 호출하면 됩니다.

    경고

    사전은 부울, Date, NSDate, 단일 및 배정밀도 부동 소수점, 정수, 문자열 유형의 속성을 통해서만 정렬할 수 있습니다.

    선언

    Swift

    func sorted(byKeyPath keyPath: String, ascending: Bool) -> Results<Value>

    매개변수

    keyPath

    정렬 기준이 되는 키 경로입니다.

    ascending

    정렬할 방향입니다.

  • 사전에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    경고

    사전은 부울, Date, NSDate, 단일 및 배정밀도 부동 소수점, 정수, 문자열 유형의 속성을 통해서만 정렬할 수 있습니다.

    ~를 참조하세요.

    sorted(byKeyPath:ascending:)

    선언

    Swift

    func sorted<S: Sequence>(by sortDescriptors: S) -> Results<Value>
        where S.Iterator.Element == SortDescriptor
  • 이 사전에 있는 모든 키를 반환합니다.

    선언

    Swift

    var keys: [Key] { get }
  • 사전에 있는 모든 값을 반환합니다.

    선언

    Swift

    var values: [Value] { get }

집계 작업

  • 컬렉션 에 있는 모든 객체 중 지정된 속성 의 최소값(가장 낮은 값)을 반환하거나, 사전이 비어 있는 경우 nil 을 반환합니다.

    경고

    유형이 MinMaxType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    Swift

    func min<T>(ofProperty property: String) -> T? where T : _HasPersistedType, T.PersistedType : MinMaxType

    매개변수

    property

    최소값을 원하는 속성의 이름입니다.

  • 사전에 있는 모든 객체 중 지정된 속성의 최대값(가장 높은 값)을 반환하거나, 사전이 비어 있는 경우 nil 을 반환합니다.

    경고

    유형이 MinMaxType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    Swift

    func max<T>(ofProperty property: String) -> T? where T : _HasPersistedType, T.PersistedType : MinMaxType

    매개변수

    property

    최소값을 원하는 속성의 이름입니다.

  • 사전에 있는 객체에 대해 지정된 속성 의 합계를 반환하거나, 사전이 비어 있는 경우 nil 을 반환합니다.

    경고

    AddableType 프로토콜을 준수하는 유형의 속성 이름만 사용할 수 있습니다.

    선언

    Swift

    func sum<T>(ofProperty property: String) -> T where T : _HasPersistedType, T.PersistedType : AddableType

    매개변수

    property

    합계를 계산할 AddableType 을(를) 준수하는 속성의 이름입니다.

  • 사전에 있는 모든 객체에 대한 지정된 속성의 평균값을 반환하거나, 사전이 비어 있는 경우 nil 을 반환합니다.

    경고

    유형이 AddableType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    Swift

    func average<T>(ofProperty property: String) -> T? where T : _HasPersistedType, T.PersistedType : AddableType

    매개변수

    property

    값을 합산해야 하는 속성의 이름입니다.

알림

  • observe(keyPaths:on:_:) 기본 구현

    딕셔너리가 변경될 때마다 호출될 차단 을 등록합니다.

    차단 은 초기 사전과 비동기적으로 호출된 다음, 사전의 키나 값을 변경하는 각 쓰기 트랜잭션 (write transaction) (write transaction) 후에 다시 호출됩니다.

    블록에 전달되는 change 매개변수는 각 쓰기 트랜잭션(write transaction) 중에 추가, 제거 또는 수정된 키-값 쌍을 사전 내의 키 형식으로 보고합니다.

    차단 이 호출되는 시점에 딕셔너리는 완전히 평가되고 최신 상태이며, 동일한 스레드에서 쓰기 트랜잭션( 쓰기 트랜잭션 (write transaction) )을 수행하지 않거나 명시적으로 realm.refresh() 호출하지 않는 한 해당 스레드에 액세스하면 차단이 수행되지 않습니다. 일.

    대기열이 제공되지 않으면 표준 이벤트 루프를 통해 알림이 전달되므로 이벤트 루프가 다른 활동에 의해 차단되는 동안에는 알림을 전달할 수 없습니다. 대기열이 제공되면 대신 해당 대기열로 알림이 전달됩니다. 알림을 즉시 전달할 수 없는 경우 여러 알림이 단일 알림으로 병합될 수 있습니다. 여기에는 초기 collection에 대한 알림이 포함될 수 있습니다.

    예를 들어 다음 코드는 알림 차단을 추가한 직후 쓰기 트랜잭션(write transaction)을 수행하므로 초기 알림이 먼저 전달될 기회가 없습니다. 결과적으로 초기 알림에는 쓰기 트랜잭션(write transaction) 후 Realm의 상태가 반영됩니다.

    let myStringMap = myObject.stringMap
    print("myStringMap.count: \(myStringMap?.count)") // => 0
    let token = myStringMap.observe { changes in
        switch changes {
        case .initial(let myStringMap):
            // Will print "myStringMap.count: 1"
            print("myStringMap.count: \(myStringMap.count)")
           print("Dog Name: \(myStringMap["nameOfDog"])") // => "Rex"
            break
        case .update:
            // Will not be hit in this example
            break
        case .error:
            break
        }
    }
    try! realm.write {
        myStringMap["nameOfDog"] = "Rex"
    }
    // end of run loop execution context
    

    키 경로를 지정하지 않으면 모든 객체 속성과 중첩되고 연결된 객체의 속성에 대해 삽입, 수정 또는 삭제할 때 차단이 실행됩니다. 하나 이상의 키 경로가 제공되면 제공된 키 경로에서만 발생하는 변경에 대해 차단이 호출됩니다. 예를 들어 다음과 같은 경우입니다.

    class Dog: Object {
        @Persisted var name: String
        @Persisted var age: Int
        @Persisted var toys: List<Toy>
    }
    // ...
    let dogs = myObject.mapOfDogs
    let token = dogs.observe(keyPaths: ["name"]) { changes in
        switch changes {
        case .initial(let dogs):
           // ...
        case .update:
           // This case is hit:
           // - after the token is initialized
           // - when the name property of an object in the
           // collection is modified
           // - when an element is inserted or removed
           //   from the collection.
           // This block is not triggered:
           // - when a value other than name is modified on
           //   one of the elements.
        case .error:
            // ...
        }
    }
    // end of run loop execution context
    
    • 관찰된 키 경로가 ["toys.brand"] 인 경우 collection 요소의 toys 목록을 삽입하거나 삭제하면 trigger 됩니다. 이 collection의 Dog 에 연결된 Toybrand 값을 변경하면 차단이 trigger됩니다. 이 collection의 Dog 에 연결된 Toy 에서 brand 이외의 값을 변경해도 차단이 trigger되지 않습니다. 관찰 중인 Dog 유형 collection을 삽입하거나 제거하면 trigger 알림이 됩니다.
    • 위의 예에서 ["toys"] 키 경로를 관찰한 경우 collection의 모든 요소에 대한 toys 목록을 삽입, 삭제 또는 수정하면 trigger가 됩니다. 이 컬렉션의 Dog 에 연결된 Toy 의 값을 변경해도 차단이 트리거 되지 않습니다 . 관찰 중인 Dog 유형 collection을 삽입하거나 제거해도 알림이 trigger됩니다.

    참고

    별도의 키 경로를 필터링하는 동일한 객체의 여러 알림 토큰은 독점적으로 필터링 되지 않습니다 . 하나의 알림 토큰에 대해 하나의 키 경로 변경이 충족되면 해당 객체에 대한 모든 알림 토큰 차단이 실행됩니다.

    블록에 업데이트를 전송하려는 한 반환된 토큰을 보관해야 합니다. 업데이트 수신을 중지하려면 토큰에서 invalidate() 을 호출합니다.

    경고

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

    참고

    keyPaths 매개 변수는 컬렉션 유형의 객체 속성을 참조하며 컬렉션 내의 특정 키/값 쌍을 참조 하지 않습니다 .

    기본 구현

    선언

    Swift

    func observe(keyPaths: [String]?,
                 on queue: DispatchQueue?,
                 _ block: @escaping (RealmMapChange<Self>) -> Void) -> NotificationToken

    매개변수

    keyPaths

    키 경로 배열에 포함된 속성만 수정 시 trigger가 속성됩니다. nil 인 경우 객체의 속성 변경에 대한 알림이 전달됩니다. 유효한 속성에 해당하지 않는 문자열 키 경로는 예외를 발생시킵니다. 연결된 속성에 대한 자세한 내용은 위의 설명을 참조하세요.

    queue

    알림을 수신할 직렬 디스패치 대기열입니다. nil 인 경우 알림이 현재 스레드로 전달됩니다.

    block

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

    반환 값

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

동결된 객체

  • 이 컬렉션 이 동결된 경우 반환

    선언

    Swift

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

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

    경고

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

    경고

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

    선언

    Swift

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

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

    선언

    Swift

    func thaw() -> Self?

Self: RealmSubscribable에서 사용 가능

Value: OptionalProtocol, Value.Wrapped: ObjectBase에서 사용 가능

  • min(of:) 확장 메서드

    collection의 모든 객체 중 지정된 속성의 최소값(최저)을 반환하거나 collection이 비어 있는 경우 nil 를 반환합니다.

    경고

    유형이 MinMaxType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    Swift

    func min<T>(of keyPath: KeyPath<Value.Wrapped, T>) -> T? where T : _HasPersistedType, T.PersistedType : MinMaxType

    매개변수

    keyPath

    최소값을 원하는 속성의 keyPath입니다.

  • max(of:) 확장 메서드

    컬렉션의 모든 객체 중 지정된 속성의 최대값(가장 높은 값)을 반환하거나, 컬렉션이 비어 있는 경우 nil 를 반환합니다.

    경고

    유형이 MinMaxType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    Swift

    func max<T>(of keyPath: KeyPath<Value.Wrapped, T>) -> T? where T : _HasPersistedType, T.PersistedType : MinMaxType

    매개변수

    keyPath

    최소값을 원하는 속성의 keyPath입니다.

  • sum(of:) 확장 메서드

    collection에 있는 객체에 지정된 속성의 합계를 반환하거나 collection이 비어 있는 경우 nil 를 반환합니다.

    경고

    AddableType 프로토콜을 준수하는 유형의 속성 이름만 사용할 수 있습니다.

    선언

    Swift

    func sum<T>(of keyPath: KeyPath<Value.Wrapped, T>) -> T where T : _HasPersistedType, T.PersistedType : AddableType

    매개변수

    keyPath

    합계를 계산할 AddableType 을(를) 준수하는 속성의 keyPath입니다.

  • average(of:) 확장 메서드

    collection의 모든 객체에 대한 지정된 속성의 평균값을 반환하거나 collection이 비어 있는 경우 nil 를 반환합니다.

    경고

    유형이 AddableType 프로토콜을 준수하는 속성만 지정할 수 있습니다.

    선언

    Swift

    func average<T>(of keyPath: KeyPath<Value.Wrapped, T>) -> T? where T : _HasPersistedType, T.PersistedType : AddableType

    매개변수

    keyPath

    값을 합산해야 하는 속성의 keyPath입니다.

Value: OptionalProtocol, Value.Wrapped: ObjectBase, Value.Wrapped: RealmCollectionValue에서 사용 가능

  • sorted(by:ascending:) 확장 메서드

    collection에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    객체는 지정된 키 경로의 값을 기준으로 정렬됩니다. 예를 들어, Studentcollection을 age 속성을 기준으로 가장 오래된 것부터 가장 오래된 것 순으로 정렬하려면 students.sorted(byKeyPath: "age", ascending: true) 를 호출할 수 있습니다.

    경고

    collection은 부울, Date, NSDate, 단일 및 배정밀도 부동 소수점, 정수, 문자열 유형의 속성을 통해서만 정렬할 수 있습니다.

    선언

    Swift

    func sorted<T>(by keyPath: KeyPath<Value.Wrapped, T>, ascending: Bool) -> Results<Value> where T : _HasPersistedType, T.PersistedType : SortableType

    매개변수

    keyPath

    정렬 기준이 되는 키 경로입니다.

    ascending

    정렬할 방향입니다.

Value.PersistedType: MinMaxType에서 사용 가능

  • min() 확장 메서드

    collection의 최소값(가장 낮은 값)을 반환하거나, collection이 비어 있는 경우 nil 을 반환합니다.

    선언

    Swift

    func min() -> Value?
  • max() 확장 메서드

    컬렉션의 최대값(가장 높은 값)을 반환하거나, 컬렉션이 비어 있는 경우 nil 를 반환합니다.

    선언

    Swift

    func max() -> Value?

Value.PersistedType: AddableType에서 사용 가능

  • sum() 확장 메서드

    collection에 있는 값의 합계를 반환하거나 collection이 비어 있는 경우 nil 을 반환합니다.

    선언

    Swift

    func sum() -> Value
  • average() 확장 메서드

    컬렉션에 있는 모든 값의 평균을 반환합니다.

    선언

    Swift

    func average<T>() -> T? where T : _HasPersistedType, T.PersistedType : AddableType

Value.PersistedType: SortableType에서 사용 가능

  • sorted(ascending:) 기본 구현

    기본 구현

    collection에 있지만 정렬된 객체를 포함하는 Results 을 반환합니다.

    객체는 해당 값을 기준으로 정렬됩니다. 예를 들어, Datecollection을 최신 항목에서 가장 오래된 항목 순으로 정렬하려면 dates.sorted(ascending: true) 을(를) 호출할 수 있습니다.

    선언

    Swift

    func sorted(ascending: Bool = true) -> Results<Value>

    매개변수

    ascending

    정렬할 방향입니다.