matlab.io.datastore.FileWritable class

Пакет: matlab.io.datastore

Добавьте поддержку записи файла datastore

Описание

matlab.io.datastore.FileWritable абстрактный класс mixin, который добавляет поддержку записи файла пользовательским хранилищам данных путем добавления поддержки writeall метод.

Чтобы использовать этот класс mixin, необходимо наследоваться matlab.io.datastore.FileWritable класс и matlab.io.Datastore базовый класс. Используйте этот синтаксис в качестве первых нескольких линий в вашем файле определения класса:

classdef MyDatastore < matlab.io.Datastore & ....
                       matlab.io.datastore.FileWritable
  ...
end
Чтобы добавить поддержку файла, пишущего в ваш пользовательский datastore, необходимо следовать за этими требованиями:

  • Наследуйте от дополнительного класса matlab.io.datastore.FileWritable.

  • Инициализируйте свойства SupportedOutputFormats и DefaultOutputFormat.

  • Реализуйте write метод, если datastore записывает данные к пользовательскому формату.

  • Реализуйте getFiles метод, если datastore не имеет Files свойство.

  • Реализуйте getFolders метод, если datastore не имеет Folders свойство.

  • Выходное местоположение подтверждено как строка. Если ваш datastore требует дальнейшей валидации, необходимо реализовать validateOutputLocation метод.

  • Если datastore предназначается для файлов, которые требуют нескольких чтений на файл, то необходимо реализовать методы getCurrentFilename и currentFileIndexComparator.

  • Для записи файла Parquet пользовательский datastore должен иметь свойство под названием ReadSize со значением file. Если datastore не имеет этого свойства, то это должно реализовать метод isSingleReadPerFile.

  • Опционально, наследуйте от другого класса matlab.io.datastore.FoldersPropertyProvider добавить поддержку Folders свойство (и таким образом FolderLayout пара "имя-значение" writeall). Если вы делаете это, то можно использовать populateFoldersFromLocation метод в конструкторе datastore, чтобы заполнить Folders свойство.

  • Добавить поддержку 'UseParallel' опция writeall, необходимо разделить на подклассы от обоих matlab.io.datastore.FileWritable и matlab.io.datastore.Partitionable и реализуйте partition метод в подклассе, который поддерживает синтаксис partition(ds,'Files',index).

matlab.io.datastore.FileWritable классом является handle класс.

Свойства

развернуть все

Список writeable форматов, возвращенных как вектор строки. Это списки свойств все возможные выходные форматы, которые могут использоваться с writeall. См. Инициализацию свойств Пользовательского Datastore для примера инициализации этого свойства в подклассе.

Атрибуты:

GetAccess
public
SetAccess
public
Constant
true
Abstract
true

Типы данных: string

Выходной формат по умолчанию, возвращенный как строковый скаляр. Это свойство дает выходной формат, чтобы использовать с writeall когда ни один не задан. См. Инициализацию свойств Пользовательского Datastore для примера инициализации этого свойства в подклассе.

Атрибуты:

GetAccess
public
SetAccess
public
Constant
true
Abstract
true

Типы данных: string

Методы

развернуть все

Примеры

свернуть все

Если вы создаете пользовательский класс datastore, который разделяет на подклассы от matlab.io.datastore.FileWritable чтобы добавить возможности записи файла, затем необходимо инициализировать свойства SupportedOutputFormats и DefaultOutputFormat в подклассе.

Например, подкласс в Разрабатывает Пользовательский Datastore для Данных DICOM, инициализирует эти свойства как:

properties (Constant)
  SupportedOutputFormats = ...
    [matlab.io.datastore.ImageDatastore.SupportedOutputFormats, "dcm"];
  DefaultOutputFormat = "dcm";
end

"dcm" пользовательский формат, который также собирается быть значением по умолчанию, но datastore также поддерживает все поддерживаемые выходные форматы ImageDatastore.

Введенный в R2020a