Flexberry ORM ODataService 5.2.0-beta01
Класс NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProviderabstract

Базовый провайдер для файловых свойств объектов данных. Подробнее...

Граф наследования:NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider:
NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider

Открытые члены

virtual FileDescription GetFileDescription (object fileProperty)
 Осуществляет получение метаданных с описанием файлового свойства объекта данных. Подробнее...
 
virtual FileDescription GetFileDescription (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение метаданных с описанием файлового свойства объекта данных. Подробнее...
 
virtual List< FileDescriptionGetFileDescriptions (DataObject dataObject)
 Осуществляет получение списка метаданных с описанием файловых свойств объекта данных, соответствующих типу FilePropertyType. Подробнее...
 
virtual object GetFileProperty (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение файлового свойства объекта данных. Подробнее...
 
abstract object GetFileProperty (string filePath)
 Осуществляет получение файлового свойства из файла, расположенного по заданному пути. Подробнее...
 
virtual object GetFileProperty (FileDescription fileDescription)
 Осуществляет получение файлового свойства объекта данных, по его метаданным. Подробнее...
 
virtual List< object > GetFileProperties (DataObject dataObject)
 Осуществляет получение списка файловых свойств объекта данных, соответствующих типу FilePropertyType. Подробнее...
 
abstract string GetFileName (object fileProperty)
 Осуществляет получение имени файла для файлового свойства объекта данных. Подробнее...
 
virtual string GetFileName (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение имени файла для файлового свойства объекта данных. Подробнее...
 
virtual string GetFileMimeType (object fileProperty)
 Осуществляет получение MIME-типа для файлового свойства объекта данных. Подробнее...
 
virtual string GetFileMimeType (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение MIME-типа для файлового свойства объекта данных. Подробнее...
 
abstract long GetFileSize (object fileProperty)
 Осуществляет получение размера файла, связанного с объектом данных, в байтах. Подробнее...
 
virtual long GetFileSize (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение MIME-типа для файлового свойства объекта данных. Подробнее...
 
abstract Stream GetFileStream (object fileProperty)
 Осуществляет получение потока данных для файлового свойства объекта данных. Подробнее...
 
virtual Stream GetFileStream (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет получение потока данных для файлового свойства объекта данных. Подробнее...
 
virtual Stream GetFileStream (FileDescription fileDescription)
 Осуществляет получение потока данных для файлового свойства объекта данных. Подробнее...
 
virtual void RemoveFile (FileDescription fileDescription)
 Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных. Подробнее...
 
virtual void RemoveFile (object fileProperty)
 Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных. Подробнее...
 
virtual void RemoveFile (DataObject dataObject, string dataObjectFilePropertyName)
 Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных. Подробнее...
 

Защищенные члены

 BaseDataObjectFileProvider (IDataService dataService)
 Конструктор класс BaseDataObjectFileProvider с параметрами. Подробнее...
 

Свойства

abstract Type FilePropertyType [get]
 Получает тип файловых свойств объектов данных, обрабатываемых провайдером. Подробнее...
 
string UploadsDirectoryPath [get, set]
 Получает или задает путь к каталогу, в котором должны храниться файлы, загруженные на сервер при помощи провайдера. Подробнее...
 
string FileBaseUrl [get, set]
 Получат или задает базовую часть URL-а для ссылок на скачивание / удаление файлов. Подробнее...
 
- Свойства унаследованные от NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider
Type FilePropertyType [get]
 Получает тип файловых свойств объектов данных, обрабатываемых провайдером. Подробнее...
 
string UploadsDirectoryPath [get, set]
 Получает или задает путь к каталогу, в котором должны храниться файлы, загруженные на сервер при помощи провайдера. Подробнее...
 
string FileBaseUrl [get, set]
 Получат или задает базовую часть URL-а для ссылок на скачивание / удаление файлов. Подробнее...
 

Подробное описание

Базовый провайдер для файловых свойств объектов данных.

Конструктор(ы)

NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.BaseDataObjectFileProvider ( IDataService  dataService)
inlineprotected

Конструктор класс BaseDataObjectFileProvider с параметрами.

Аргументы
dataServiceСервис данных для операций с БД.

Методы

virtual FileDescription NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileDescription ( object  fileProperty)
inlinevirtual

Осуществляет получение метаданных с описанием файлового свойства объекта данных.

Аргументы
filePropertyФайловое свойство объекта данных, для которого требуется получить метаданные файла.
Возвращает
Метаданные с описанием файлового свойства объекта данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

Переопределяется в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider.

virtual FileDescription NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileDescription ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)
inlinevirtual

Осуществляет получение метаданных с описанием файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
Метаданные с описанием файлового свойства объекта данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual List<FileDescription> NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileDescriptions ( DataObject  dataObject)
inlinevirtual

Осуществляет получение списка метаданных с описанием файловых свойств объекта данных, соответствующих типу FilePropertyType.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловые свойства.
Возвращает
Список метаданных с описанием файловых свойств объекта данных, соответствующих типу FilePropertyType.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileMimeType ( object  fileProperty)
inlinevirtual

Осуществляет получение MIME-типа для файлового свойства объекта данных.

Аргументы
filePropertyФайловому свойству объекта данных, для которого требуется получить MIME-тип.
Возвращает
MIME-тип файла, соответствующего заданному файловому свойству.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileMimeType ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)
inlinevirtual

Осуществляет получение MIME-типа для файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство, для которого требуется получить MIME-тип.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
MIME-тип файла, соответствующего заданному файловому свойству.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

abstract string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileName ( object  fileProperty)
pure virtual

Осуществляет получение имени файла для файлового свойства объекта данных.

Аргументы
filePropertyФайловому свойству объекта данных, для которого требуется получить имя файла.
Возвращает
Имя файла.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider.

virtual string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileName ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)
inlinevirtual

Осуществляет получение имени файла для файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство, для которого требуется получить имя.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
Имя файла.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual List<object> NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileProperties ( DataObject  dataObject)
inlinevirtual

Осуществляет получение списка файловых свойств объекта данных, соответствующих типу FilePropertyType.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловые свойства.
Возвращает
Список файловых свойств объекта данных, соответствующих типу FilePropertyType.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual object NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileProperty ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)
inlinevirtual

Осуществляет получение файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
Значение файлового свойства объекта данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

abstract object NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileProperty ( string  filePath)
pure virtual

Осуществляет получение файлового свойства из файла, расположенного по заданному пути.

Аргументы
filePathПуть к файлу.
Возвращает
Значение файлового свойства объекта данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider.

virtual object NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileProperty ( FileDescription  fileDescription)
inlinevirtual

Осуществляет получение файлового свойства объекта данных, по его метаданным.

При необходимости будет вычитан объект данных.

Аргументы
fileDescriptionМетаданные с описанием файлового свойства объекта данных.
Возвращает
Значение файлового свойства объекта данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

abstract long NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileSize ( object  fileProperty)
pure virtual

Осуществляет получение размера файла, связанного с объектом данных, в байтах.

Аргументы
filePropertyФайловое свойство объекта данных, для которого требуется получить размер файла.
Возвращает
Размер файла в байтах.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider.

virtual long NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileSize ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)
inlinevirtual

Осуществляет получение MIME-типа для файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство, для которого требуется получить MIME-тип.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
MIME-тип файла, соответствующего заданному файловому свойству.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

abstract Stream NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileStream ( object  fileProperty)
pure virtual

Осуществляет получение потока данных для файлового свойства объекта данных.

Аргументы
filePropertyЗначение файлового свойства объекта данных, для которого требуется получить поток данных.
Возвращает
Поток данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

Замещается в NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectWebFileProvider и NewPlatform.Flexberry.ORM.ODataService.Files.Providers.DataObjectFileProvider.

virtual Stream NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileStream ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)
inlinevirtual

Осуществляет получение потока данных для файлового свойства объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство, для которого требуется получить поток данных.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.
Возвращает
Поток данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual Stream NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.GetFileStream ( FileDescription  fileDescription)
inlinevirtual

Осуществляет получение потока данных для файлового свойства объекта данных.

При необходимости будет вычитан объект данных.

Аргументы
fileDescriptionМетаданные с описанием файлового свойства объекта данных, для которого требуется получить поток данных.
Возвращает
Поток данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual void NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.RemoveFile ( FileDescription  fileDescription)
inlinevirtual

Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных.

Аргументы
fileDescriptionМетаданные удаляемого файла.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual void NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.RemoveFile ( object  fileProperty)
inlinevirtual

Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных.

Аргументы
filePropertyЗначение файлового свойства объекта данных, для которого требуется выполнить удаление.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

virtual void NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.RemoveFile ( DataObject  dataObject,
string  dataObjectFilePropertyName 
)
inlinevirtual

Осуществляет удаление из файловой системы файла, соответствующего файловому свойству объекта данных.

При необходимости будет произведена дочитка объекта данных.

Аргументы
dataObjectОбъект данных, содержащий файловое свойство.
dataObjectFilePropertyNameИмя файлового свойства в объекте данных.

Замещает NewPlatform.Flexberry.ORM.ODataService.Files.Providers.IDataObjectFileProvider.

Полный список свойств

string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.FileBaseUrl
getset

Получат или задает базовую часть URL-а для ссылок на скачивание / удаление файлов.

abstract Type NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.FilePropertyType
get

Получает тип файловых свойств объектов данных, обрабатываемых провайдером.

string NewPlatform.Flexberry.ORM.ODataService.Files.Providers.BaseDataObjectFileProvider.UploadsDirectoryPath
getset

Получает или задает путь к каталогу, в котором должны храниться файлы, загруженные на сервер при помощи провайдера.