Documentation

COItem documentation

COItem : NSObject <NSCopying, NSMutableCopying>

COItem is a "semi-serialized" representation of an inner object.

AuthorsGenerated by qmathe
Declared inCOItem.h

Overview

It is essentially just a strongly typed dictionary (See COType.h for the mapping between possible COType values and the corresponding permissible Objective-C classes). Note that COItem only contains "value" obects (or possibly, sets/arrays of value objects). So, for example, references to other inner objects are stored as ETUUID instances. COItem acts as an intermediate layer during serialization or deserialization - the binary and JSON formats are both straightforward mappings of COItem to a byte stream.

COItem helps decouple object graph concerns (which are handled by COObjectGraphContext) from the details of actual serialization (handled by COItem(Binary) and COItem(JSON), and COItem also defines the abstract storage model (independent of a particular serialization format like binary or JSON) that CoreObject uses.

Initialization

- (id) initWithUUID: (ETUUID *)aUUID typesForAttributes: (NSDictionary *)typesForAttributes valuesForAttributes: (NSDictionary *)valuesForAttributes

    + (COItem *) itemWithTypesForAttributes: (NSDictionary *)typesForAttributes valuesForAttributes: (NSDictionary *)valuesForAttributes
    Description forthcoming.

      Accessing Attributes

      - (ETUUID *) UUID
      Description forthcoming.
        - (NSArray *) attributeNames
        Description forthcoming.
          - (COType) typeForAttribute: (NSString *)anAttribute
          Description forthcoming.
            - (id) valueForAttribute: (NSString *)anAttribute
            Description forthcoming.

              Convenience

              - (NSArray *) allObjectsForAttribute: (NSString *)attribute
              Description forthcoming.
                - (NSSet *) compositeReferencedItemUUIDs
                Description forthcoming.
                  - (NSSet *) referencedItemUUIDs
                  Description forthcoming.
                    - (NSSet *) allInnerReferencedItemUUIDs
                    Description forthcoming.
                      - (NSArray *) attachments
                      Description forthcoming.
                        - (NSArray *) allReferencedPersistentRootUUIDs
                        Description forthcoming.
                          - (NSString *) fullTextSearchContent
                          Description forthcoming.

                            Copying

                            - (id) copyWithZone: (NSZone *)zone
                            Description forthcoming.
                              - (id) mutableCopyWithZone: (NSZone *)zone
                              Description forthcoming.
                                - (id) mutableCopyWithNameMapping: (NSDictionary *)aMapping

                                Returns a mutable item.