Обзор

Можно создать индексы Центра внимания, где каждая запись индексируется индивидуально. Эта функция только поддерживается в не, документ базировал приложения. Для основанных на документе приложений необходимо использовать метаданные хранилища, как описано в Индексации Уровня метаданных Хранилища.

В этом подходе Базовые Данные управляют каталогом в Библиотеке/Кэшах/Метаданных/Ядре, Data/в корневом каталоге пользователя (структура этого каталога является частной — не зависят от него). Для каждой отдельной программы Базовые Данные создают подкаталог; в каждом подкаталоге Данные Ядра создают дальнейший подкаталог для каждого персистентного хранилища, используемого программой. В каталоге для данного хранилища, для каждого экземпляра каждого объекта, который Вы принимаете решение индексировать, Удаляют сердцевину Данных, создает новый внешний рекордный файл. Внешние рекордные файлы используются Центром внимания для индексации персистентного хранилища.

Существует три процесса, вовлеченные в создание и поддержание индекса Центра внимания:

• Ваша программа.

  В Вашей программе Базовая платформа Данных поддерживает персистентное хранилище и создает внешние рекордные файлы для инициирования индексации центра внимания

• Средство импорта Центра внимания.

  Средство импорта делает фактическую индексацию. Это запускается каждый раз, когда изменяется внешняя запись.

  Необходимо записать и поддержать средство импорта; для каждой внешней записи это должно добавить подходящие данные к индексу Центра внимания. Это - во многих отношениях самая важная часть разработки средства импорта.

• Базовые Данные Внешний Рекордный демон.

  Это - вторичный процесс, используемый Базовой платформой Данных. Это используется для улучшения производительности при изменении большого количества записей (больше чем приблизительно сто) одновременно. В этой ситуации Базовые Данные пишут единственный рабочий файл, который внешний демон впоследствии распаковывает для создания отдельных внешних записей.

Основная цель внешнего рекордного файла состоит в том, чтобы просто служить указателем на запись (экземпляр объекта) в персистентном хранилище. В средстве импорта Вы выбираете соответствующий управляемый объект от персистентного хранилища своего приложения и используете его для обновления индекса Центра внимания.

При условии, что по крайней мере одно свойство для объекта указано как индексируемый (см. Конфигурирование Модели), тогда каждый раз, когда изменение в экземпляре того объекта посвящает себя персистентному хранилищу, соответствующий внешний рекордный файл обновляется (минимально измененная дата последнего изменения). Внешний рекордный файл может быть пустым (файл нулевой длины), однако можно также, дополнительно, указать свойства, Данные Ядра значений которых должны сохранить в файле. Средство импорта не использует данных, которые Вы, возможно, указали, должен быть сохранен в самой внешней записи (чтобы понять, как Вы могли бы использовать его, посмотрите Используя Внешние Записи).

Создание проекта

Когда Вы создаете новый проект с XCode, выбираете, не документ базировал приложение, использующее Базовые Данные для хранения и имеющее Индексацию Центра внимания (“Базовое Применение данных со Средством импорта Центра внимания”). Шаблон Xcode добавляет файлы Средства импорта и создает цель сборки для средства импорта. Существует тогда две цели, которыми необходимо управлять — приложение и средство импорта. Они оба совместно используют общую модель управляемого объекта.

Конфигурирование модели

Для включения индексации Центра внимания необходимо указать который, свойства которого объекты должны быть индексированы и который — если кто-либо — тех свойств должен быть добавлен к внешней записи.

В инспекторе Конфигурации, для каждого из свойств, что Вы хотите быть индексированными, выберите:

• Индекс в центре внимания

• (Необязательно) Хранилище во внешнем рекордном файле

При условии, что по крайней мере одному свойству для объекта установили флаг «Index in Spotlight», тогда каждый раз, когда изменение в экземпляре того объекта посвящает себя персистентному хранилищу, соответствующий внешний рекордный файл обновляется (минимально измененная дата последнего изменения). Это означает, что средство импорта Центра внимания будет работать и таким образом, индекс Центра внимания будет обновлен с новыми данными.

Если Вы только выбираете «Index in Spotlight», Core Data просто создает файл нулевой длины для соответствующей записи. Если Вы также выбираете «Store in External Record», свойство добавляется к содержанию внешней записи. Простые типы, такие как строки, даты, и числа, экспортируются непосредственно; отношения сохранены как UUIDs.

Средство импорта самостоятельно не использует данных, которые Вы, возможно, указали, должен быть сохранен во внешней записи. Можно, однако, хотеть использовать внешние записи сами, например для восстановления после ошибки или помогать отладке — посмотрите Используя Внешние Записи. Если Вы не делаете, тем не менее, для предотвращения издержек дублирования данных и занимания места на диске, Вы не должны принимать решение сохранить значения свойств во внешней записи.

Конфигурирование Вашей Программы

Существует несколько опций, которые можно установить для хранилища для указания, где внешние записи должны быть сохранены, расширение для внешних рекордных имен файлов и формат, в котором должны быть записаны внешние записи:

NSExternalRecordsDirectoryOption

Эта константа указывает каталог URL, где сохранены внешние записи.

Необходимо указать каталог в пользователе Library/Caches/Metadata/CoreData или Library/CoreData каталог. Необходимо использовать это в сочетании с NSExternalRecordsExtensionOption опция.

NSExternalRecordExtensionOption

Эта константа указывает расширение, используемое для внешних рекордных файлов.

Необходимо использовать это в сочетании с NSExternalRecordsDirectoryOption опция.

NSExternalRecordsFileFormatOption

Эта константа указывает формат файла для использования при записи внешних записей.

Значение по умолчанию должно записать записи как XML (NSXMLExternalRecordType) Если Вы хотите человекочитаемый формат или хотите быть в состоянии совместно использовать содержание с другими приложениями — это - хороший выбор. Иначе необходимо обычно использовать двоичный формат (NSBinaryExternalRecordType).

Вы устанавливаете эти опции при конфигурировании персистентного координатора хранилища, как показано в следующем примере:

NSString *externalRecordsSupportFolder = <#Path for records folder#>;

NSURL *storeURL = <#URL for the store#>;

NSMutableDictionary *storeOptions = @{

    NSExternalRecordExtensionOption:@"MyExtension",

    NSExternalRecordsDirectoryOption:externalRecordsSupportFolder,

    NSExternalRecordsFileFormatOption:NSBinaryExternalRecordType};

NSPersistentStoreCoordinator *aPSC = <#Get the coordinator#>;.

if (![aPSC addPersistentStoreWithType:NSSQLiteStoreType configuration:nil URL:storeURL

           options:storeOptions error:&error]) {

    [[NSApplication sharedApplication] presentError:error];

}

Реализация средства импорта

В этом разделе описываются прежде всего функции средства импорта, которые уникальны для Базовых Данных. Для понимания основных принципов того, как реализовать средство импорта Центра внимания необходимо считать Руководство по программированию Средства импорта Центра внимания. Отметьте также, что большая часть конфигурации и подробных данных реализации обсуждены в Средстве импорта файл ReadMe и предоставлены как комментарии в шаблонах.

Вообще говоря существует два аспекта к реализации средства импорта: конфигурируя настройки проекта, например, расширение файла для Вашего внешнего типа записи; и настройка метода, добавляющего данные от записи до индекса Центра внимания. Последним аспектом является, вероятно, самый важный аспект задачи.

- (BOOL)importFileAtPath:(NSString *)filePath attributes:(NSMutableDictionary *)spotlightData error:(NSError **)error

NSDictionary *pathInfo = [NSPersistentStoreCoordinator elementsDerivedFromExternalRecordURL:[NSURL fileURLWithPath:filePath]];

self.modelURL = [NSURL fileURLWithPath:[pathInfo valueForKey:NSModelPathKey]];

self.storeURL = [NSURL fileURLWithPath:[pathInfo valueForKey:NSStorePathKey]];

NSURL *objectURI = [pathInfo valueForKey:NSObjectURIKey];

NSManagedObject *instance = [[self managedObjectContext] objectWithID:oid];

NSString *displayString = <#Create a display string from a managed object#>;

[spotlightData setObject:displayString forKey:(__bridge id<NSCopying>)kMDItemDisplayName];

- (BOOL)import<EntityName>:(EntityClass *)instance

                attributes:(NSMutableDictionary *)spotlightData

- (BOOL)importFileAtPath:(NSString *)filePath attributes:(NSMutableDictionary *)spotlightData error:(NSError **)error {

    NSDictionary *pathInfo =

        [NSPersistentStoreCoordinator elementsDerivedFromExternalRecordURL:

                                            [NSURL fileURLWithPath:filePath]];

    NSString *entityName = [pathInfo objectForKey:NSEntityNameInPathKey];

    self.modelURL = [NSURL fileURLWithPath:[pathInfo valueForKey:NSModelPathKey]];

    self.storeURL = [NSURL fileURLWithPath:[pathInfo valueForKey:NSStorePathKey]];

    NSURL  *objectURI = [pathInfo valueForKey:NSObjectURIKey];

    NSManagedObjectID *oid =

        [[self persistentStoreCoordinator] managedObjectIDForURIRepresentation:objectURI];

    if (!oid) {

        NSLog(@"%@:%s to find object id from path %@", [self class], _cmd, filePath);

        return NO;

    }

    /*

     Create and invoke an NSInvocation object that sends a message to self where:

         The selector follows the format import<EntityName>:attributes:

         The return value is a BOOL.

    */

    NSString *importSelectorString =

        [NSString stringWithFormat:@"import%@:attributes:", entityName];

    SEL importSelector = NSSelectorFromString(importSelectorString);

    if (![self respondsToSelector:importSelector]) {

        NSLog(@"%@:%s Couldn't import an instance of entity %@",

            [self class], _cmd, entityName);

        return NO;

    }

    NSManagedObject *instance = [[self managedObjectContext] objectWithID:oid];

    NSMethodSignature *methodSignature = [self methodSignatureForSelector:importSelector];

    NSInvocation *invocation =

        [NSInvocation invocationWithMethodSignature:methodSignature];

    [invocation setTarget:self];

    [invocation setSelector:importSelector];

    [invocation setArgument:&instance atIndex:2];

    [invocation setArgument:&spotlightData atIndex:3];

    BOOL returnValue;

    [invocation invoke];

    [invocation getReturnValue:&returnValue];

    return returnValue;

}

- (BOOL)importPerson:(Person *)person attributes:(NSMutableDictionary *)spotlightData {

    // Set the display name for Spotlight search results.

    [spotlightData setObject:[person fullName] forKey:(__bridge id<NSCopying>)kMDItemDisplayName];

    NSDate *dob = person.dateOfBirth;

    if (dob != nil) {

        [spotlightData setObject:dob forKey:(__bridge id<NSCopying>)kMDItemTimestamp];

    }

    NSMutableString *text = [NSMutableString stringWithFormat:@"%@", [person fullName]];

    for (NSManagedObject *address in person.addresses) {

        NSString *component;

        component = [address street1];

        if (component) {

            [text appendFormat:@" %@", component];

        }

        component = [address city];

        if (component) {

            [text appendFormat:@" %@", component];

        }

        component = [address state];

        if (component) {

            [text appendFormat:@" %@", component];

        }

        component = [address zip];

        if (component) {

            [text appendFormat:@" %@", component];

        }

    }

    [spotlightData setObject:text forKey:(__bridge id<NSCopying>)kMDItemTextContent];

    return YES;

}

Открытие внешней записи

Когда пользователь делает выбор после поиска Центра внимания, заключительный аспект поддержки интеграции Центра внимания должен вывести на экран надлежащую запись. Необходимо реализовать метод делегата приложения application:openFiles: реагировать на открытый запрос файла на внешнюю запись:

- (void)application:(NSApplication *)theApplication openFiles:(NSArray *)files {

    NSString *aPath = [files lastObject]; // Just an example to get at one of the paths.

    if (aPath && [aPath hasSuffix:YOUR_EXTERNAL_RECORD_EXTENSION]) {

        // Decode URI from path.

        NSURL *objectURI = [[NSPersistentStoreCoordinator elementsDerivedFromExternalRecordURL:[NSURL fileURLWithPath:aPath]] objectForKey:NSObjectURIKey];

        if (objectURI) {

            NSManagedObjectID *moid = [[self persistentStoreCoordinator] managedObjectIDForURIRepresentation:objectURI];

            if (moid) {

                    NSManagedObject *mo = [[self managedObjectContext] objectWithID:moid];

                    // Your code to select the object in your application's UI.

            }

        }

    }

}

Шаблон показывает, как идентифицировать управляемый объект, который выбрал пользователь. То, как Вы тогда гарантируете, что этот объект выведен на экран в пользовательском интерфейсе, зависит полностью на Вашу архитектуру приложения и схему в Вашей модели управляемого объекта.

Используя внешние записи

Средство импорта не использует данных, которые Вы, возможно, указали, должен быть сохранен в самой внешней записи (см. Обзор). В других программах, однако, можно использовать следующий NSPersistentStoreCoordinator методы для взаимодействия с внешними записями:

• elementsDerivedFromExternalRecordURL: метод класса, берущий URL к внешнему рекордному файлу и возвращающий словарь с полученными элементами, такими как имя объекта и URI для экземпляра управляемого объекта.

• importStoreWithIdentifier:fromExternalRecordsDirectory:toURL:options:withType:error: создает и заполняет новое хранилище с помощью внешних записей, найденных в указанном расположении.

При некоторых обстоятельствах, поэтому, Вы могли использовать внешнюю запись, например, для восстановления после ошибки или воссоздать хранилище, так или иначе ставшее поврежденным. Вы могли бы также использовать представление XML для разрешения обмена данными с другими программами. Вам решать для решения, какая информация могла бы быть полезной и в том, какие ситуации Вы могли бы использовать эти данные, и поэтому который, свойства которого объекты Вы хотите включать во внешнюю запись.

Структура внешнего каталога записей, как гарантируют, не останется постоянной между выпусками операционной системы. Вы можете, тем не менее, независимо от их расположения, просто выполнять итерации через внешние каталоги записей (например, с помощью NSFileManager enumeratorAtPath:) получать все файлы, расширение пути которых - это, которое Вы указали для своих внешних записей.

Можно также использовать внешние записи в качестве диагностики при разработке программы и средства импорта. Можно ли гарантировать, что корректная информация добавляется к записям, и что они обновляются, когда Вы ожидаете, что они будут — несмотря на то, что отмечают протест в том, Почему мои записи в синхронизации не?.

Поиск и устранение неисправностей

Много подсказок для поиска и устранения неисправностей даны в Руководстве по программированию Средства импорта Центра внимания. В частности можно протестировать использование средства импорта /usr/bin/mdimport, как проиллюстрировано этим примером:

/usr/bin/mdimport -d2 ~/Library/Caches/Metadata/CoreData/$ApplicationName/$StoreID/$Entity/$fileName

// Clear out all custom classes used by the model to avoid having to link them

// with the importer. Remove this code if you need to access your custom logic.

NSString *managedObjectClassName = [NSManagedObject className];

for (NSEntityDescription *entity in managedObjectModel) {

    if (![[entity name] isEqualToString:@"Person"]) {

        [entity setManagedObjectClassName:managedObjectClassName];

    }

}

FAQ